Sign in

v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB
Pools

Update pool

⚠️ This endpoint is in public preview.

Update a pool. Omitted fields are left unchanged.

patch/preview/v2/pools/{id}

Path parameters

idstring required

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.

Example:pool_k3R-nX9vLm7Qp2Yw5Jd8F

Request body

namestring
tagsTags

Example request

{
  "name": "my-resource-name",
  "tags": {
    "env": "prod",
    "team": "infra"
  }
}

Response

Pool updated.

idstring required
resource_pathstring required

A resource path for a pool resource. Format: sfc:pool:<account>:<workspace>:<name>.

ownerstring required
workspacestring required
workspace_idstring required
namestring required
kind'market' | 'originating' | 'read_only' required

Pool kind determines what operations are allowed on a pool.

  • Market: User-created pools. - Originating: Provider pools for selling compute. Cannot add compute (buy orders/procurements). - ReadOnly: System-managed pools used for legacy compute, bare metal contracts, and other. Cannot be modified through the API.
object'pool' required

Discriminator for /pools responses.

created_atinteger required

Unix timestamp.

tagsTags

Example response

{
  "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"
  }
}