Skip to main content
GET
List pools

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

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 Capacity:List and Capacity:Read (granted at either the workspace or organization level). 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"

id
string[]

Filter by pool ID, resource path, or name (repeatable).

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})
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 200
starting_after
string

Set to the response's cursor to fetch the next page.

Pattern: ^poolc_[A-Za-z0-9_-]+$
Example:

"poolc_gqXR7s0Kj5mHvE2wNpLc4Q"

ending_before
string

Set to the response's cursor to fetch the previous page.

Pattern: ^poolc_[A-Za-z0-9_-]+$
Example:

"poolc_gqXR7s0Kj5mHvE2wNpLc4Q"

schedule_history_minutes
integer<u-int64>
default:0

How many minutes of past schedule to include.

Required range: 0 <= x <= 1440
tag
string[]

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

tag_key
string[]

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

Response

Paginated list of pools.

object
string
default:list
required
read-only
Allowed value: "list"
has_more
boolean
required
data
object[]
required
cursor
null | string

Pass as starting_after or ending_before to paginate.

Pattern: ^poolc_[A-Za-z0-9_-]+$
Example:

"poolc_gqXR7s0Kj5mHvE2wNpLc4Q"