Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Pools

List pools

⚠️ This endpoint is in public preview.

List all pools.

get/preview/v2/pools

Query parameters

workspacestring

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

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).

idResourcePathOrIdPoolId[]

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

[
  "pool_k3R-nX9vLm7Qp2Yw5Jd8F"
]
limitinteger
starting_afterstring
Example:poolc_gqXR7s0Kj5mHvE2wNpLc4Q

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

ending_beforestring
Example:poolc_gqXR7s0Kj5mHvE2wNpLc4Q

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

schedule_history_minutesinteger

How many minutes of past schedule to include.

tagstring[]

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

tag_keystring[]

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'list' required
cursorstring
has_moreboolean required

Example response

{
  "cursor": "poolc_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "id": "pool_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:pool:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
      "name": "my-resource-name",
      "allocation_schedule": {
        "total": [
          {
            "start_at": 1738972800,
            "end_at": 1738972800
          }
        ]
      },
      "procurements": [
        {
          "id": "proc_k3R-nX9vLm7Qp2Yw5Jd8F",
          "name": "my-resource-name"
        }
      ],
      "deployments": [
        {
          "id": "depl_k3R-nX9vLm7Qp2Yw5Jd8F",
          "name": "my-resource-name"
        }
      ],
      "created_at": 1738972800,
      "tags": {
        "env": "prod",
        "team": "infra"
      }
    }
  ]
}