Skip to main content
GET
List deployments

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"

pool
string

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

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

"pool_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"