Skip to main content
GET
/
preview
/
v2
/
pools
List pools
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/pools \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "object": "pool",
      "id": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "<string>",
      "owner": "<string>",
      "workspace": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "allocation_schedule": {
        "total": [
          {
            "start_at": 1738972800,
            "node_count": 123,
            "end_at": 1738972800
          }
        ],
        "by_instance_sku": {}
      },
      "created_at": 1738972800,
      "procurements": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "deployments": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "tags": {
        "env": "prod",
        "team": "infra"
      }
    }
  ],
  "cursor": "poolc_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"

​
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}|cap_[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"