Skip to content

List regions.

GET
/v1/regions
Code sample: Shell / cURL
curl --request GET \
--url https://stratum.example.com/v1/regions \
--header 'Authorization: Bearer <token>'

Ordered by name ascending. This catalog is stable and small, so the order is part of the contract: a client may rely on it rather than re-sorting defensively.

Returns every region in one response — nextPageToken is never populated.

Regions.

Media typeapplication/json
object
items
required
Array<object>
object
name
required
string
/^[a-z][a-z0-9]+(-[a-z0-9]+)*$/
displayName
required
string
description
string
state
required
string
Allowed values: active draining deleted
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextPageToken
string

Example

{
"items": [
{
"state": "active"
}
]
}