v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB

Deployments

List deployments

⚠️ This endpoint is in public preview.

List all deployments.

get/preview/v2/deployments

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.

poolstring

A resource path like 'sfc:pool:acme:prod:my-pool' 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:pool_k3R-nX9vLm7Qp2Yw5Jd8F

Filter by pool.

limitinteger

starting_afterstring

Example:deplc_gqXR7s0Kj5mHvE2wNpLc4Q

ending_beforestring

Example:deplc_gqXR7s0Kj5mHvE2wNpLc4Q

Response

Paginated list of deployments.

object'list' required

cursorstring

has_moreboolean required

Example response

{
  "cursor": "deplc_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:deployment:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
      "name": "my-resource-name",
      "capacity": {
        "id": "cap_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "pool": {
        "id": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "instance_sku": {
        "id": "isku_k3R-nX9vLm7Qp2Yw5Jd8F",
        "alias": "my-resource-name"
      },
      "instance_template": {
        "id": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "instance_name_template": "my-fleet-{{nanoid(9)}}",
      "created_at": 1738972800,
      "updated_at": 1738972800
    }
  ]
}