Sign Up

Regions

List regions

GET
/regions

Lists the caller's regions at every level as one flat list, each parent before its children and siblings ordered by ID. Edges that cannot be used are not listed, and neither are broader regions with no listed edge under them. A broader region whose edges all opt out of automatic placement stays listed with available: false and cannot be named in a create.

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Response Body

The regions

application/json
  1. response

The caller's regions, at every level.

default_region_id*|

ID of the edge region a sandbox create that names no region uses for this caller: the project's default region, else the organization's, else the platform's. null when that region is not listed.

regions*array<>

Every listed region, parents before their children.

curl -X GET 'https://example.com/regions'
{  "default_region_id": "string",  "regions": [    {      "api_base_url": "string",      "available": true,      "id": "string",      "level": "global",      "name": "string",      "parent_region_id": "string"    }  ]}