Skip to main content
GET
/
v1
/
projects
/
{projectId}
/
warm-pool
Get warm pool config
curl --request GET \
  --url https://capy.ai/api/v1/projects/{projectId}/warm-pool \
  --header 'Authorization: Bearer <token>'
{
  "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

Success

allowed
boolean
required
config
object
required
status
object
required
metadata
object
required