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. |
global_region_id | string | The global region this region belongs to; omitted when the region is not grouped. |
GET /global-regions
List the global regions — broad placement targets (world, us, eu, asia, …) that group individual regions. Each entry reports its active member count. Read-only.
| Field | Type | Description |
|---|---|---|
id | string | Global region slug — a valid value to pass as region on creates. |
name | string | Human-readable name. |
member_count | int | Number of active member regions. |
Selecting a global region as region places the sandbox in one of its member regions (the platform picks one, preferring regions with available capacity). world matches every region that belongs to some global region; a region with no global_region_id is excluded from all global selection and reachable only by its exact slug.
Choosing a region on create
POST /vms and POST /images accept an optional region — a region slug or a global region id. 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 global region with no active members fails with 400 as well. 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.