---
title: "List nodes"
method: GET
path: "/nodes"
tags: ["admin"]
---

# List nodes

`GET /nodes`

List all nodes

## Query parameters

- `clusterID` string, uuid

## Response `200`

Successfully returned all nodes

- Node[]
  - `version` string, required — Version of the orchestrator
  - `commit` string, required — Commit of the orchestrator
  - `id` string, required — Identifier of the node
  - `serviceInstanceID` string, required — Service instance identifier of the node
  - `clusterID` string, required — Identifier of the cluster
  - `machineInfo` MachineInfo, required
    - `cpuFamily` string, required — CPU family of the node
    - `cpuModel` string, required — CPU model of the node
    - `cpuModelName` string, required — CPU model name of the node
    - `cpuArchitecture` string, required — CPU architecture of the node
  - `status` 'ready' | 'draining' | 'connecting' | 'unhealthy' | 'standby', required — Status of the node. - draining: the node is bound to be shut down. It will not accept new sandboxes and will stop once all existing sandboxes are done. - standby: the node is not actively used, but it can return to ready and continue serving traffic.
  - `statusChangedAt` string, date-time, required — Time when the node status was last changed
  - `sandboxCount` integer, required — Number of sandboxes running on the node
  - `metrics` NodeMetrics, required — Node metrics
    - `allocatedCPU` integer, required — Number of allocated CPU cores
    - `cpuPercent` integer, required — Node CPU usage percentage
    - `cpuCount` integer, required — Total number of CPU cores on the node
    - `allocatedMemoryBytes` integer, required — Amount of allocated memory in bytes
    - `memoryUsedBytes` integer, required — Node memory used in bytes
    - `memoryTotalBytes` integer, required — Total node memory in bytes
    - `hugePagesTotal` integer, required — Total number of preallocated hugepages on the node
    - `hugePagesUsed` integer, required — Number of hugepages in use (total - free)
    - `hugePagesReserved` integer, required — Number of reserved hugepages (committed but not yet faulted)
    - `hugePageSizeBytes` integer, required — Size of a single hugepage in bytes
    - `disks` DiskMetrics[], required — Detailed metrics for each disk/mount point
      - `mountPoint` string, required — Mount point of the disk
      - `device` string, required — Device name
      - `filesystemType` string, required — Filesystem type (e.g., ext4, xfs)
      - `usedBytes` integer, required — Used space in bytes
      - `totalBytes` integer, required — Total space in bytes
  - `createSuccesses` integer, required — Number of sandbox create successes
  - `createFails` integer, required — Number of sandbox create fails
  - `sandboxStartingCount` integer, required — Number of starting Sandboxes

## Other responses

- `401` — Authentication error
- `500` — Server error

## Changes

- **2026-08-20** `e01b3f5506fe` — 2 info
  - added the optional property `error_code` to the response with the `401` status
  - added the optional property `error_code` to the response with the `500` status
- **2026-07-24** `93ed246a4c10` — 16 info
  - the endpoint scheme security `AdminApiKeyAuth` was added to the API
  - the endpoint scheme security `AdminTokenAuth` was removed from the API
  - removed `#/components/schemas/Node` from the `items/` response property `allOf` list for the response status `200`
  - added the required property `items/clusterID` to the response with the `200` status
  - …12 more
- **2026-05-27** `e13ef89d456c` — 1 warning, 1 info
  - added the new `standby` enum value to the `items/allOf[#/components/schemas/Node]/status` response property for the response status `200`
  - added the new optional `query` request parameter `clusterID`
- **2026-03-26** `324629e18dc8` — 1 breaking
  - removed the required property `items/allOf[#/components/schemas/Node]/nodeID` from the response with the `200` status
- **2026-01-12** `83a3cddc628f` — 1 info
  - added the required property `items/allOf[#/components/schemas/Node]/machineInfo` to the response with the `200` status

[Full history](https://skmtc.dev/e2b-dev/apis/e2b-api/changes/nodes/get.md)

---

[API](https://skmtc.dev/e2b-dev/apis/e2b-api.md) · [All operations](https://skmtc.dev/e2b-dev/apis/e2b-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/e2b-dev/e2b-api/revisions/e01b3f5506fe/schema)