Skip to main content
PATCH
/
v2
/
sandboxes
/
pools
/
{name}
Update a Sandbox Pool
curl --request PATCH \
  --url https://api.example.com/v2/sandboxes/pools/{name} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "replicas": 1
}
'
{
  "name": "<string>",
  "template_name": "<string>",
  "replicas": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "<string>",
  "updated_at": "<string>"
}

Path Parameters

​
name
string
required

Pool name

Body

application/json

Request model for updating a Sandbox Pool.

You can update the display name and/or the replica count. The template reference cannot be changed after creation.

​
name
string | null

New display name for the pool (max 63 chars, DNS-1035 format). Must be unique within the organization.

​
replicas
integer | null

Number of sandboxes to pre-provision (minimum 0). Set to 0 to pause the pool without deleting it.

Required range: x >= 0

Response

Successful Response

Response model for a Sandbox Pool.

​
name
string
required
​
template_name
string
required
​
replicas
integer
required

Desired number of replicas

​
id
string<uuid> | null

Unique pool identifier

​
created_at
string | null
​
updated_at
string | null