Skip to main content
GET
/
preview
/
v2
/
deployments
List deployments
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/deployments \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "<string>",
      "resource_path": "<string>",
      "owner": "<string>",
      "workspace": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "object": "deployment",
      "capacity": {
        "id": "<string>",
        "name": "<string>"
      },
      "instance_template": {
        "id": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "<string>"
      },
      "target_instance_count": 123,
      "instance_name_template": "<string>",
      "status": {
        "message": "<string>"
      },
      "created_at": 1738972800,
      "updated_at": 1738972800
    }
  ],
  "cursor": "deplc_gqXR7s0Kj5mHvE2wNpLc4Q"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
workspace
string
required

Filter by workspace. 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.

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

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

​
capacity
string

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.

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

"cap_k3R-nX9vLm7Qp2Yw5Jd8F"

​
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 50
​
starting_after
string
Pattern: ^deplc_[A-Za-z0-9_-]+$
Example:

"deplc_gqXR7s0Kj5mHvE2wNpLc4Q"

​
ending_before
string
Pattern: ^deplc_[A-Za-z0-9_-]+$
Example:

"deplc_gqXR7s0Kj5mHvE2wNpLc4Q"

Response

Paginated list of deployments.

​
object
string
default:list
required
read-only
Allowed value: "list"
​
has_more
boolean
required
​
data
object[]
required
​
cursor
null | string
Pattern: ^deplc_[A-Za-z0-9_-]+$
Example:

"deplc_gqXR7s0Kj5mHvE2wNpLc4Q"