API reference

Base URL: https://braesystems.com/api

Every endpoint requires an API key:


Authorization: Bearer bs_live_...

Servers

GET`/api/v1/servers`

List servers

Every server in your account, with its addresses and current status.

Example request


curl https://braesystems.com/api/v1/servers \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
 
async function main(): Promise<void> {
  const response = await fetch("https://braesystems.com/api/v1/servers", {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
 
async function main() {
  const response = await fetch("https://braesystems.com/api/v1/servers", {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import requests
 
api_key = "bs_live_..."
 
response = requests.get(
    "https://braesystems.com/api/v1/servers",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	apiKey := "bs_live_..."
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/servers", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": [
    {
      "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
      "name": "kelp-01",
      "status": "active",
      "model": "PowerEdge R760xa",
      "environment_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
      "image": "ubuntu-24-04",
      "ipv4": [
        {
          "address": "203.0.113.11",
          "version": 4,
          "kind": "public"
        }
      ],
      "ipv6": [
        {
          "address": "203.0.113.11",
          "version": 4,
          "kind": "public"
        }
      ],
      "created_at": "2026-07-29T14:03:11.000Z"
    }
  ]
}

Responses

200	The servers in your account.
401	Missing or invalid API key.
429	More than 1000 requests from this key in 60 seconds.

GET`/api/v1/servers/{id}`

Get a server

Path parameters

id*

uuid

Server id.

Example request


curl https://braesystems.com/api/v1/servers/$SERVER_ID \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
server_id = os.environ["SERVER_ID"]
 
response = requests.get(
    f"https://braesystems.com/api/v1/servers/{server_id}",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	apiKey := "bs_live_..."
	serverID := os.Getenv("SERVER_ID")
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/servers/" + serverID + "", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "name": "kelp-01",
    "status": "active",
    "model": "PowerEdge R760xa",
    "environment_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "image": "ubuntu-24-04",
    "ipv4": [
      {
        "address": "203.0.113.11",
        "version": 4,
        "kind": "public"
      }
    ],
    "ipv6": [
      {
        "address": "203.0.113.11",
        "version": 4,
        "kind": "public"
      }
    ],
    "created_at": "2026-07-29T14:03:11.000Z"
  }
}

Responses

200	The server.
401	Missing or invalid API key.
404	No such resource in this account.
429	More than 1000 requests from this key in 60 seconds.

GET`/api/v1/servers/{id}/ips`

List a server's IP addresses

Both IPv4 and IPv6 addresses assigned to the server.

Path parameters

id*

uuid

Server id.

Example request


curl https://braesystems.com/api/v1/servers/$SERVER_ID/ips \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/ips`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/ips`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
server_id = os.environ["SERVER_ID"]
 
response = requests.get(
    f"https://braesystems.com/api/v1/servers/{server_id}/ips",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	apiKey := "bs_live_..."
	serverID := os.Getenv("SERVER_ID")
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/servers/" + serverID + "/ips", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": [
    {
      "address": "203.0.113.11",
      "version": 4,
      "kind": "public"
    }
  ]
}

Responses

200	The server's addresses.
401	Missing or invalid API key.
404	No such resource in this account.
429	More than 1000 requests from this key in 60 seconds.

POST`/api/v1/servers/{id}/reboot`

Reboot a server

Requests a graceful restart, escalating to a forced restart if the machine does not come back in time. Returns immediately with an action; poll `GET /api/v1/actions/{id}` to follow it.

Path parameters

id*

uuid

Server id.

Example request


curl -X POST https://braesystems.com/api/v1/servers/$SERVER_ID/reboot \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/reboot`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/reboot`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
server_id = os.environ["SERVER_ID"]
 
response = requests.post(
    f"https://braesystems.com/api/v1/servers/{server_id}/reboot",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	apiKey := "bs_live_..."
	serverID := os.Getenv("SERVER_ID")
 
	req, err := http.NewRequest("POST", "https://braesystems.com/api/v1/servers/" + serverID + "/reboot", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "server_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "kind": "reboot",
    "status": "queued",
    "error": null,
    "simulated": false,
    "created_at": "2026-07-29T14:03:11.000Z",
    "completed_at": null
  }
}

Responses

202	Reboot accepted.
401	Missing or invalid API key.
404	No such resource in this account.
409	The server is busy or not in a state that allows this. A `server-busy` problem carries `action_id`, the operation to poll before retrying.
429	More than 1000 requests from this key in 60 seconds.

POST`/api/v1/servers/{id}/power`

Power a server on or off

Powering off asks the guest to shut down cleanly, and forces it off only if it does not go in time. A server that is already in the state you asked for is a `409`, not a silent success. A powered-off server cannot be rebooted or re-imaged until it is back on. Returns immediately with an action; poll `GET /api/v1/actions/{id}` to follow it.

Path parameters

id*

uuid

Server id.

Request body

direction*

"on" | "off"

Which way to move the server. Powering off asks the guest to shut down cleanly first, and forces it off only if it does not.

Example request


curl -X POST https://braesystems.com/api/v1/servers/$SERVER_ID/power \
  -H "Authorization: Bearer bs_live_..." \
  -H "Content-Type: application/json" \
  -d '{"direction":"off"}'


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/power`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ direction: "off" }),
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/power`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ direction: "off" }),
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
server_id = os.environ["SERVER_ID"]
 
response = requests.post(
    f"https://braesystems.com/api/v1/servers/{server_id}/power",
    headers={"Authorization": f"Bearer {api_key}"},
    json={"direction": "off"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	apiKey := "bs_live_..."
	serverID := os.Getenv("SERVER_ID")
 
	body := strings.NewReader(`{"direction":"off"}`)
 
	req, err := http.NewRequest("POST", "https://braesystems.com/api/v1/servers/" + serverID + "/power", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "server_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "kind": "reboot",
    "status": "queued",
    "error": null,
    "simulated": false,
    "created_at": "2026-07-29T14:03:11.000Z",
    "completed_at": null
  }
}

Responses

202	Power command accepted.
400	Body is not `{ "direction": "on" \| "off" }`.
401	Missing or invalid API key.
404	No such resource in this account.
409	The server is busy or not in a state that allows this. A `server-busy` problem carries `action_id`, the operation to poll before retrying.
429	More than 1000 requests from this key in 60 seconds.

POST`/api/v1/servers/{id}/reimage`

Re-image a server

Wipes the server and installs a fresh operating system. **All data on the machine is destroyed.** The selected SSH keys are installed during the install — this is the only point at which keys reach a server. Returns immediately with an action; poll `GET /api/v1/actions/{id}` to follow it.

Path parameters

id*

uuid

Server id.

Request body

image*	string	Slug of an image from GET /api/v1/images.
ssh_key_ids	uuid[]	Keys to install on the rebuilt machine. Defaults to every key on the account. This is the only point at which SSH keys reach a server.

Example request


curl -X POST https://braesystems.com/api/v1/servers/$SERVER_ID/reimage \
  -H "Authorization: Bearer bs_live_..." \
  -H "Content-Type: application/json" \
  -d '{"image":"ubuntu-24-04"}'


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/reimage`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ image: "ubuntu-24-04" }),
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/reimage`, {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ image: "ubuntu-24-04" }),
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
server_id = os.environ["SERVER_ID"]
 
response = requests.post(
    f"https://braesystems.com/api/v1/servers/{server_id}/reimage",
    headers={"Authorization": f"Bearer {api_key}"},
    json={"image": "ubuntu-24-04"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)
 
func main() {
	apiKey := "bs_live_..."
	serverID := os.Getenv("SERVER_ID")
 
	body := strings.NewReader(`{"image":"ubuntu-24-04"}`)
 
	req, err := http.NewRequest("POST", "https://braesystems.com/api/v1/servers/" + serverID + "/reimage", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "server_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "kind": "reboot",
    "status": "queued",
    "error": null,
    "simulated": false,
    "created_at": "2026-07-29T14:03:11.000Z",
    "completed_at": null
  }
}

Responses

202	Re-image accepted.
400	Unknown image, or an SSH key id that is not on this account.
401	Missing or invalid API key.
404	No such resource in this account.
409	The server is busy or not in a state that allows this. A `server-busy` problem carries `action_id`, the operation to poll before retrying.
429	More than 1000 requests from this key in 60 seconds.

Actions

GET`/api/v1/servers/{id}/actions`

List a server's actions

The hundred most recent actions on the server, newest first, whoever started them. Use it to find an operation you do not hold the id of.

Path parameters

id*

uuid

Server id.

Example request


curl https://braesystems.com/api/v1/servers/$SERVER_ID/actions \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/actions`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const serverId = process.env.SERVER_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/servers/${serverId}/actions`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
server_id = os.environ["SERVER_ID"]
 
response = requests.get(
    f"https://braesystems.com/api/v1/servers/{server_id}/actions",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	apiKey := "bs_live_..."
	serverID := os.Getenv("SERVER_ID")
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/servers/" + serverID + "/actions", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": [
    {
      "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
      "server_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
      "kind": "reboot",
      "status": "queued",
      "error": null,
      "simulated": false,
      "created_at": "2026-07-29T14:03:11.000Z",
      "completed_at": null
    }
  ]
}

Responses

200	The server's actions.
401	Missing or invalid API key.
404	No such resource in this account.
429	More than 1000 requests from this key in 60 seconds.

GET`/api/v1/actions/{id}`

Get an action

Poll this to follow a reboot or re-image to completion.

Path parameters

id*

uuid

Action id.

Example request


curl https://braesystems.com/api/v1/actions/$ACTION_ID \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
const actionId = process.env.ACTION_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/actions/${actionId}`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const actionId = process.env.ACTION_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/actions/${actionId}`, {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
action_id = os.environ["ACTION_ID"]
 
response = requests.get(
    f"https://braesystems.com/api/v1/actions/{action_id}",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	apiKey := "bs_live_..."
	actionID := os.Getenv("ACTION_ID")
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/actions/" + actionID + "", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "server_id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "kind": "reboot",
    "status": "queued",
    "error": null,
    "simulated": false,
    "created_at": "2026-07-29T14:03:11.000Z",
    "completed_at": null
  }
}

Responses

200	The action.
401	Missing or invalid API key.
404	No such resource in this account.
429	More than 1000 requests from this key in 60 seconds.

SSH keys

GET`/api/v1/ssh-keys`

List SSH keys

Example request


curl https://braesystems.com/api/v1/ssh-keys \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
 
async function main(): Promise<void> {
  const response = await fetch("https://braesystems.com/api/v1/ssh-keys", {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
 
async function main() {
  const response = await fetch("https://braesystems.com/api/v1/ssh-keys", {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import requests
 
api_key = "bs_live_..."
 
response = requests.get(
    "https://braesystems.com/api/v1/ssh-keys",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	apiKey := "bs_live_..."
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/ssh-keys", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": [
    {
      "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
      "name": "work-laptop",
      "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com",
      "fingerprint": "SHA256:qqLkC/YxINXheBw7fxT6z9s92H80dJJkSIuDy3d/GJs",
      "created_at": "2026-07-29T14:03:11.000Z"
    }
  ]
}

Responses

200	The keys on your account.
401	Missing or invalid API key.
429	More than 1000 requests from this key in 60 seconds.

POST`/api/v1/ssh-keys`

Add an SSH key

Adds a key to the account. Existing servers are unaffected — keys are installed during a re-image.

Request body

name*	string
public_key*	string	An OpenSSH public key, e.g. the contents of ~/.ssh/id_ed25519.pub

Example request


curl -X POST https://braesystems.com/api/v1/ssh-keys \
  -H "Authorization: Bearer bs_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name":"work-laptop","public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com"}'


const apiKey = "bs_live_...";
 
async function main(): Promise<void> {
  const response = await fetch("https://braesystems.com/api/v1/ssh-keys", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ name: "work-laptop", public_key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com" }),
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
 
async function main() {
  const response = await fetch("https://braesystems.com/api/v1/ssh-keys", {
    method: "POST",
    headers: {
      Authorization: `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ name: "work-laptop", public_key: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com" }),
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import requests
 
api_key = "bs_live_..."
 
response = requests.post(
    "https://braesystems.com/api/v1/ssh-keys",
    headers={"Authorization": f"Bearer {api_key}"},
    json={"name": "work-laptop", "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"strings"
)
 
func main() {
	apiKey := "bs_live_..."
 
	body := strings.NewReader(`{"name":"work-laptop","public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com"}`)
 
	req, err := http.NewRequest("POST", "https://braesystems.com/api/v1/ssh-keys", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
	req.Header.Set("Content-Type", "application/json")
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "name": "work-laptop",
    "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com",
    "fingerprint": "SHA256:qqLkC/YxINXheBw7fxT6z9s92H80dJJkSIuDy3d/GJs",
    "created_at": "2026-07-29T14:03:11.000Z"
  }
}

Responses

201	The key was added.
400	The public key could not be parsed.
401	Missing or invalid API key.
409	A key with this fingerprint is already on the account.
429	More than 1000 requests from this key in 60 seconds.

DELETE`/api/v1/ssh-keys/{id}`

Delete an SSH key

Removes the key from the account. Servers already carrying it keep it until they are re-imaged. Answers with the key as it was, so a caller can confirm what went.

Path parameters

id*

uuid

SSH key id.

Example request


curl -X DELETE https://braesystems.com/api/v1/ssh-keys/$SSH_KEY_ID \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
const sshKeyId = process.env.SSH_KEY_ID;
 
async function main(): Promise<void> {
  const response = await fetch(`https://braesystems.com/api/v1/ssh-keys/${sshKeyId}`, {
    method: "DELETE",
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
const sshKeyId = process.env.SSH_KEY_ID;
 
async function main() {
  const response = await fetch(`https://braesystems.com/api/v1/ssh-keys/${sshKeyId}`, {
    method: "DELETE",
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import os
 
import requests
 
api_key = "bs_live_..."
ssh_key_id = os.environ["SSH_KEY_ID"]
 
response = requests.delete(
    f"https://braesystems.com/api/v1/ssh-keys/{ssh_key_id}",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
	"os"
)
 
func main() {
	apiKey := "bs_live_..."
	sshKeyID := os.Getenv("SSH_KEY_ID")
 
	req, err := http.NewRequest("DELETE", "https://braesystems.com/api/v1/ssh-keys/" + sshKeyID + "", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": {
    "id": "9f1c7d2e-4a3b-4c5d-8e6f-0a1b2c3d4e5f",
    "name": "work-laptop",
    "public_key": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIDjG7RPA1EpqDMvKeai1v1ibjWe2ZBKQRqIEB3PvLJgq you@example.com",
    "fingerprint": "SHA256:qqLkC/YxINXheBw7fxT6z9s92H80dJJkSIuDy3d/GJs",
    "created_at": "2026-07-29T14:03:11.000Z"
  }
}

Responses

200	The key that was deleted.
401	Missing or invalid API key.
404	No such resource in this account.
429	More than 1000 requests from this key in 60 seconds.

Images

GET`/api/v1/images`

List operating system images

Images that can be passed as `image` to the re-image endpoint.

Example request


curl https://braesystems.com/api/v1/images \
  -H "Authorization: Bearer bs_live_..."


const apiKey = "bs_live_...";
 
async function main(): Promise<void> {
  const response = await fetch("https://braesystems.com/api/v1/images", {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = (await response.json()) as { data: unknown };
  console.log(data);
}
 
void main();


const apiKey = "bs_live_...";
 
async function main() {
  const response = await fetch("https://braesystems.com/api/v1/images", {
    headers: {
      Authorization: `Bearer ${apiKey}`,
    },
  });
 
  if (!response.ok) {
    throw new Error(`Brae API ${response.status}: ${await response.text()}`);
  }
 
  const { data } = await response.json();
  console.log(data);
}
 
void main();


import requests
 
api_key = "bs_live_..."
 
response = requests.get(
    "https://braesystems.com/api/v1/images",
    headers={"Authorization": f"Bearer {api_key}"},
    timeout=30,
)
response.raise_for_status()
 
print(response.json()["data"])


package main
 
import (
	"fmt"
	"io"
	"net/http"
)
 
func main() {
	apiKey := "bs_live_..."
 
	req, err := http.NewRequest("GET", "https://braesystems.com/api/v1/images", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+apiKey)
 
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
 
	out, err := io.ReadAll(resp.Body)
	if err != nil {
		panic(err)
	}
 
	fmt.Println(resp.Status, string(out))
}

Example response


{
  "data": [
    {
      "slug": "ubuntu-24-04",
      "name": "Ubuntu 24.04 LTS"
    }
  ]
}

Responses

200	Available images.
401	Missing or invalid API key.
429	More than 1000 requests from this key in 60 seconds.

API reference

Servers

GET/api/v1/servers

GET/api/v1/servers/{id}

GET/api/v1/servers/{id}/ips

POST/api/v1/servers/{id}/reboot

POST/api/v1/servers/{id}/power

POST/api/v1/servers/{id}/reimage

Actions

GET/api/v1/servers/{id}/actions

GET/api/v1/actions/{id}

SSH keys

GET/api/v1/ssh-keys

POST/api/v1/ssh-keys

DELETE/api/v1/ssh-keys/{id}

Images

GET/api/v1/images

GET`/api/v1/servers`

GET`/api/v1/servers/{id}`

GET`/api/v1/servers/{id}/ips`

POST`/api/v1/servers/{id}/reboot`

POST`/api/v1/servers/{id}/power`

POST`/api/v1/servers/{id}/reimage`

GET`/api/v1/servers/{id}/actions`

GET`/api/v1/actions/{id}`

GET`/api/v1/ssh-keys`

POST`/api/v1/ssh-keys`

DELETE`/api/v1/ssh-keys/{id}`

GET`/api/v1/images`