Skip to content
Open Markdown

List runtime nodes ​

GET /v1/admin/runtime/nodes

  • Operation ID: listRuntimeNodes
  • Tags: Runtime pools and nodes
  • Base URL: http://localhost:8787

Up to 200 nodes with capacity, load and GPU status. If the runtime is unreachable the response is still 200 with { available: false }. Authenticates with a Platform staff JWT and permission, like every admin route; the backend calls the separate Runtime service on the caller's behalf (no Runtime API key is ever exposed or accepted).

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission runtime.read.

Authentication ​

  • Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
  • Required permissions: runtime.read

Responses ​

200 ​

Nodes.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object | object (RuntimeUnavailable)

FieldTypeRequiredDescription
(variant 1).availablebooleanyesOne of: true
(variant 1).dataobjectyes-
(variant 1).data.items(object (RuntimeNode))[]yes-
(variant 1).data.items[].idstringyes-
(variant 1).data.items[].poolIdstringyes-
(variant 1).data.items[].hostnamestringyes-
(variant 1).data.items[].addressstringyes-
(variant 1).data.items[].labelsobjectyes-
(variant 1).data.items[].instanceTypestringyes-
(variant 1).data.items[].maxSessionsintegeryes-
(variant 1).data.items[].agentVersionstringyes-
(variant 1).data.items[].statusstringyesOne of: "online", "offline"
(variant 1).data.items[].drainingbooleanyes-
(variant 1).data.items[].lastSeenAtintegeryesLast agent heartbeat (Unix epoch milliseconds).
(variant 1).data.items[].createdAtintegeryesCreated (Unix epoch milliseconds).
(variant 1).data.items[].connectedbooleanyes-
(variant 1).data.items[].freeSessionsintegeryes-
(variant 1).data.items[].capacityobject | nullyes-
(variant 1).data.items[].usedobjectyes-
(variant 1).data.items[].used.sessionsintegeryes-
(variant 1).data.items[].used.cpusnumberyes-
(variant 1).data.items[].used.memoryMbnumberyes-
(variant 1).data.items[].used.gpuSharenumberyes-
(variant 1).data.items[].loadany | nullno-
(variant 1).data.items[].imagesany[]yes-
(variant 1).data.items[].hardwareobject | nullyesCPU/memory/GPU inventory reported by the agent.
(variant 1).data.items[].gpusobject[] | nullyesGPU inventory merged with the latest live sample.
(variant 1).data.nextCursorstring | nullyes-
(variant 2).availablebooleanyesOne of: false

Errors ​

401 ​

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

FieldTypeRequiredDescription
errorstringyesStable machine-readable error code, e.g. forbidden, not_found.
detailsanynoOptional structured context. For 403 it is { perm }.

Error response

json
{
  "error": "missing_token"
}

403 ​

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "forbidden",
  "details": {
    "perm": "runtime.read"
  }
}

500 ​

Unexpected server error (internal). No details are returned.

  • Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

json
{
  "error": "internal"
}

Examples ​

curl ​

bash
curl -X GET 'http://localhost:8787/v1/admin/runtime/nodes' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

TypeScript ​

ts
const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/runtime/nodes", {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
  },
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();

Try this endpoint

Requests go directly from your browser to the API. Send request executes this endpoint against the selected server.

GET/v1/admin/runtime/nodes

Your token stays in this tab's memory and is sent only when you press Send request.

Built for developers. Ready for agents.