v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB

Instances

List instances

⚠️ This endpoint is in public preview.

List all instances.

get/preview/v2/instances

Query parameters

workspacestring

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

Scope the returned list to a single workspace (ID, resource path, or name). Without it, the returned list spans every workspace where the caller has Instance:List and Instance:Read (granted at either the workspace or organization level).

Filter by instance ID (repeatable).

[
  "inst_k3R-nX9vLm7Qp2Yw5Jd8F"
]

poolResourcePathOrIdPoolId[]

Filter by pool (repeatable). Instances on any of the given pools match.

[
  "pool_k3R-nX9vLm7Qp2Yw5Jd8F"
]

statusInstanceStatus[]

Filter by instance status (repeatable).

created_afterinteger

Filter to instances created at or after this Unix timestamp (seconds).

created_beforeinteger

Filter to instances created at or before this Unix timestamp (seconds).

Filter by instance SKU (repeatable). Instances on any of the given SKUs match.

[
  "isku_k3R-nX9vLm7Qp2Yw5Jd8F"
]

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.

includeInstanceInclude[]

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

{
  "cursor": "nodec_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "id": "inst_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:instance:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
      "name": "my-resource-name",
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "alias": "my-resource-name"
      },
      "capacity": {
        "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "pool": {
        "id": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "created_at": 1738972800,
      "updated_at": 1738972800,
      "image": {
        "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "managed_by": {
        "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo=",
      "firewall": "frwl_k3R-nX9vLm7Qp2Yw5Jd8F",
      "tags": {
        "env": "prod",
        "team": "infra"
      },
      "expected_shutdown_at": 1738972800
    }
  ]
}