Regions
List available regions and select one when you create a sandbox.
A region is the location where a sandbox runs. Each region pools one or more datacenters. Select a region to place a sandbox near your users or your data.
List regions
The response includes only regions with free capacity for a new sandbox.
const regions = await client.regions.list();regions = client.regions.list()# no dedicated CLI command — use pt api
pt api /v1/regionscurl -s "$PT_API_URL/v1/regions" \
-H "Authorization: Bearer $PT_TOKEN"| Field | Type | Meaning |
|---|---|---|
region | string | Key to pass as region at create |
label | string | Display name |
gpuAvailable | boolean | Region has GPU capacity |
Select a region at create
The region is fixed at create. You cannot move a sandbox to another region.
If the region has no capacity for the requested shape, create fails. Retry with another region or a smaller shape.
A volume pins placement. An attached volume ties the sandbox to the host that holds the volume. This overrides the region you pass.
Pass region on sandbox create.
const sbx = await client.sandboxes.create({ template: "pt-base", region: "eu-west" });sbx = client.sandboxes.create(template="pt-base", region="eu-west")pt sandbox create -t pt-base --region eu-westcurl -s -X POST "$PT_API_URL/v1/sandboxes?wait_for_state=running" \
-H "Authorization: Bearer $PT_TOKEN" \
-H "Content-Type: application/json" \
-d '{"template":"pt-base","region":"eu-west"}'| You pass | Placement |
|---|---|
| A known region | Any datacenter in that region with capacity |
| Nothing | The template's region if set, else any region |
The sandbox object carries the assigned region. Read it with sandbox get.
Full endpoint schemas: API reference.