Sign in

v44

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-20129390589.6 KB
Instances

List instances

⚠️ This endpoint is in public preview.

List all instances.

get/preview/v2/instances

Query parameters

workspacestring required

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

Example:wksp_k3R-nX9vLm7Qp2Yw5Jd8F

Filter by workspace.

idSfcApiInstanceId[]

Filter by instance ID (repeatable).

[
  "inst_k3R-nX9vLm7Qp2Yw5Jd8F"
]
capacitystring

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

Example:cap_k3R-nX9vLm7Qp2Yw5Jd8F

Filter by capacity.

statusSfcApiInstanceStatus[]

Filter by instance status (repeatable).

limitinteger
starting_afterstring
Example:nodec_gqXR7s0Kj5mHvE2wNpLc4Q

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

ending_beforestring
Example:nodec_gqXR7s0Kj5mHvE2wNpLc4Q

Cursor for backward pagination.

includeSfcApiInstanceInclude[]

Additional fields to include in the response.

tagstring[]

Filter by tag key-value pair (repeatable). Format: key=value (the = between key and value must be percent-encoded in the URL).

tag_keystring[]

Filter by tag key existence (repeatable). Returns resources that have a tag with this key, regardless of the value.

Response

Paginated list of instances.

object'list' required
cursorstring
has_moreboolean required

Example response

{
  "object": "list",
  "cursor": "nodec_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "id": "inst_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:instance:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "name": "my-resource-name",
      "object": "instance",
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "capacity": {
        "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "created_at": 1738972800,
      "image": {
        "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "deployment": {
        "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo=",
      "tags": {
        "env": "prod",
        "team": "infra"
      },
      "expected_shutdown_at": 1738972800
    }
  ]
}