Get warm pool config

Get warm pool configuration, pool status counts, and whether warm pool is enabled for the project’s organization.

GET /v1/projects/{projectId}/warm-pool

Get warm pool config

cURL

curl --request GET \
  --url https://capy.ai/api/v1/projects/{projectId}/warm-pool \
  --header 'Authorization: Bearer <token>'

200

{
  "allowed": true,
  "config": {
    "enabled": true,
    "targetSize": 123,
    "maxAgeMinutes": 123,
    "branch": "<string>",
    "setupCommands": [
      {
        "name": "<string>",
        "command": "<string>",
        "background": true
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "status": {
    "ready": 0,
    "provisioning": 0,
    "failed": 0
  },
  "metadata": {
    "lastProvisionedAt": "<string>",
    "lastClaimedAt": "<string>"
  }
}

Authorizations

Authorization · string · header · required

API token (capy_xxxx). Generate at capy.ai/settings/tokens

Path Parameters

projectId · string · required

Project ID.

Response

200

application/json

Success

allowed · boolean · required

config · object · required

Show child attributes

status · object · required

Show child attributes

metadata · object · required

Show child attributes