Skip to main content
GET
/
v2
/
nodes
/
{id}
Get node
curl --request GET \
  --url https://api.sfcompute.com/v2/nodes/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "resource_path": "<string>",
  "owner": "<string>",
  "workspace": "<string>",
  "name": "<string>",
  "object": "node",
  "status": "awaiting_allocation",
  "capacity": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
  "created_at": 1738972800,
  "image": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
  "cloud_init_user_data_used": true,
  "zone": "richmond",
  "deployment": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
  "cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo=",
  "tags": {
    "env": "prod",
    "team": "infra"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

A resource path like 'sfc:node:acme:prod:my-node' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Pattern: (node_[0-9a-zA-Z_-]{1,21})|(sfc:node:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,3})
Example:

"node_k3R-nX9vLm7Qp2Yw5Jd8F"

Query Parameters

​
expand
enum<string>[]
Available options:
capacity,
image,
deployment

Response

Node details.

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

"node_k3R-nX9vLm7Qp2Yw5Jd8F"

​
resource_path
string
required

A resource path for a node resource. Format: sfc:node:::.

Pattern: sfc:node:([a-zA-Z0-9._-]+:){2}[a-zA-Z0-9._-]+
Example:

"sfc:node:<account_id>:<workspace>:<name>"

​
owner
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
workspace
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
name
string
required
Required string length: 1 - 255
Pattern: [a-zA-Z0-9][a-zA-Z0-9._-]{0,254}
Example:

"my-resource-name"

​
object
string
default:node
required
read-only
Allowed value: "node"
​
status
enum<string>
required

awaiting_allocation when waiting for compute allocation on its capacity, running once assigned and physical node is running (still takes time for image to be downloaded and booted), terminated when stopped by user or after running out of allocation, failed on hardware fault.

Available options:
awaiting_allocation,
running,
terminated,
failed
​
capacity
required

Capacity this node is utilizing.

Pattern: cap_[0-9a-zA-Z_-]{1,21}
Example:

"cap_k3R-nX9vLm7Qp2Yw5Jd8F"

​
created_at
integer<int64>
required

Unix timestamp.

Example:

1738972800

​
image
required

Image this node was launched from.

Pattern: image_[0-9a-zA-Z_-]{1,21}
Example:

"image_k3R-nX9vLm7Qp2Yw5Jd8F"

​
cloud_init_user_data_used
boolean
required

Whether cloud-init user data is configured for this node.

​
zone
null | string

Zone this node is running in. Only present when assigned to a physical node.

Example:

"richmond"

​
deployment

Deployment managing this node, if any.

Pattern: depl_[0-9a-zA-Z_-]{1,21}
Example:

"depl_k3R-nX9vLm7Qp2Yw5Jd8F"

​
cloud_init_user_data
string<byte>

Base64-encoded cloud-init user data.

Example:

"IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo="

​
tags
object

Metadata tags attached to this node.

Example:
{ "env": "prod", "team": "infra" }