E2e2b-dev
admin

List nodes

Changed on

List all nodes

get/nodes

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/nodes
  • Auth
    • API key in header X-Admin-Token
    • or HTTP bearer

Query parameters

clusterIDstring uuid

Identifier of the cluster

Response

Successfully returned all nodes

versionstring required

Version of the orchestrator

commitstring required

Commit of the orchestrator

idstring required

Identifier of the node

serviceInstanceIDstring required

Service instance identifier of the node

clusterIDstring required

Identifier of the cluster

status'ready' | 'draining' | 'connecting' | 'unhealthy' | 'standby' | 'shutting_down' required

Status of the node.

  • standby: the node is not actively used, but it can return to ready and continue serving traffic.
statusChangedAtstring date-time required

Time when the node status was last changed

sandboxCountinteger required

Number of sandboxes running on the node

maxSandboxesinteger required

Cached node-scoped sandbox admission limit. Nonpositive values reject creation.

outstandingWorkinteger required

Cached count of work holds on the node. Zero means idle or not yet reported; it does not by itself authorize deletion.

createSuccessesinteger required

Number of sandbox create successes

createFailsinteger required

Number of sandbox create fails

sandboxStartingCountinteger required

Number of starting Sandboxes

Changes

  • 5241139475f3Revision changes
    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

  • a37f50c70019Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status