Skip to main content
GET
/
v2
/
nodes
List nodes
curl --request GET \
  --url https://api.sfcompute.com/v2/nodes \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "object": "node",
      "id": "<string>",
      "status": "pending",
      "zone": "richmond",
      "capacity": "<string>",
      "node_template": "<string>"
    }
  ],
  "cursor": "nodec_gqXR7s0Kj5mHvE2wNpLc4Q"
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

​
id
string[]

Filter by node ID (repeatable).

Pattern: node_[0-9a-zA-Z_-]{1,21}
​
capacity
string

Filter by capacity. An ID or name identifying this resource.

Pattern: (cap_[0-9a-zA-Z_-]{1,21}) | ([a-zA-Z0-9][a-zA-Z0-9._-]{0,254})
Example:

"cap_k3R-nX9vLm7Qp2Yw5Jd8F"

​
status
enum<string>[]

Filter by node status (repeatable).

pending on creation while waiting for hardware assignment, running once assigned (note: the node may still be booting or loading a custom image), terminated when destroyed, failed on hardware fault.

Available options:
pending,
running,
terminated,
failed
​
include_deleted
boolean
default:false

Include deleted nodes in the response. Currently terminated nodes are auto-deleted. Don't expect this behavior to be stable.

​
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 200
​
starting_after
string

Cursor for forward pagination (from a previous response's cursor field).

Pattern: ^nodec_[A-Za-z0-9_-]+$
Example:

"nodec_gqXR7s0Kj5mHvE2wNpLc4Q"

​
ending_before
string

Cursor for backward pagination.

Pattern: ^nodec_[A-Za-z0-9_-]+$
Example:

"nodec_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of nodes.

​
object
string
default:list
required
Allowed value: "list"
​
has_more
boolean
required
​
data
object[]
required
​
cursor
null | string

Pass as starting_after or ending_before to paginate.

Pattern: ^nodec_[A-Za-z0-9_-]+$
Example:

"nodec_gqXR7s0Kj5mHvE2wNpLc4Q"