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

Body

application/json

Request model for creating a Sandbox Pool.

Pools pre-provision sandboxes from a template for faster claim binding. Templates with volume mounts cannot be used in pools since volumes are stateful and cannot be shared across pool replicas.

​
name
string
required

Name of the pool (max 63 chars, DNS-1035 format: lowercase alphanumeric and hyphens, must start with letter)

​
template_name
string
required

Name of the SandboxTemplate to use. The template must not have any volume mounts.

​
replicas
integer
required

Number of sandboxes to pre-provision (minimum 1)

Required range: x >= 1
​
wait_for_ready
boolean
default:true

If true, wait for at least one replica to be ready before returning. This ensures claims can immediately bind to the pool.

​
timeout
integer | null

Timeout in seconds when wait_for_ready is true (default: 120, max: 600)

Required range: 10 <= x <= 600

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