- Method:
GET
- Path:
/v1/orgs/{org}/compute/regions
- Operation ID:
listRegions
- Tag: Compute
Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.
| Name |
Type |
Required |
Description |
org |
string (uuid) |
Yes |
The organization’s id. |
| Field |
Type |
Required |
Enum |
Description |
items |
array of RegionOut |
Yes |
|
|
items.access |
string |
Yes |
public, restricted |
public: every organization may use it. restricted: only selected organizations may; the rest see it listed but locked. |
items.datacenter |
string |
Yes |
|
|
items.entitled |
boolean |
Yes |
|
Whether this organization may use the region. Always true for a public region. A restricted region this is false for offers no sizes, images, storage pools or network profiles to this organization, and refuses a create exactly as an unknown region does. True does not mean the region takes instances today: that is status. |
items.id |
string |
Yes |
|
|
items.name |
string |
Yes |
|
|
items.status |
string |
Yes |
|
active | coming_soon | maintenance | retired. |
next_cursor |
string, nullable |
No |
|
|
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 401 |
The credential is missing or invalid. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/compute/regions" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"