Regions
Discover available regions.
Every sandbox, image, and snapshot is homed in a region. This endpoint lists the regions currently available so clients and SDKs can populate region pickers and validate targets. The catalog is read-only. See the Regions guide.
GET /regions
List the active regions. The response is a JSON array; disabled regions are excluded.
No parameters.
| Field | Type | Description |
|---|---|---|
id | string | Region slug — the value to pass as region on creates. |
name | string | Human-readable name. |
status | string | Always "active" in this list. |
is_default | bool | Whether this is the platform default region. |
toolbox_proxy_url | string | Regional proxy endpoint for in-sandbox tooling; omitted when not configured. |
Choosing a region on create
POST /vms and POST /images accept an optional region slug. When omitted, the region resolves in this order:
- Project default region (if configured)
- Organization default region (if configured)
- Platform default region (
is_default: true)
An unknown or disabled region fails the create with 400. A sandbox runs only in its home region; referencing an image or disk snapshot homed elsewhere triggers replication into the target region on first use — the create returns 409 ("replicating…; retry shortly") until the replica is ready. Full (memory+disk) snapshots are region-pinned and restore only in their home region.
Errors
401— missing or invalid API key.