Sign in
pools

Resize a pool's desired count. Grow places new VMs (all-or-nothing); shrink removes newest placements (LIFO). Placements are available at GET /pools/{id}/placements.

patch/pools/{id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/pools/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Request body

$schemastring uri

A URL to the JSON Schema for this object.

desired_countinteger required

Example request

{
  "$schema": "/api/v1/schemas/ResizePoolInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

created_atstring date-time required
datacenter_idstring required
desired_countinteger required
idstring required
metadataunknown
namestring required
slot_idstring required
updated_atstring date-time required

Example response

{
  "$schema": "/api/v1/schemas/PoolView.json"
}

Changes

No recorded changes to this operation across all 13 revisions of this API.