Logo
OpenScaler

Get region

GET
/v1/regions/{id}

Retrieve a single region by ID, including country display metadata.

Authorization

bearer_auth
AuthorizationBearer <token>

Authentication

Create an API token on Profile. Send it in the Authorization header:

Authorization: Bearer os1_...

Do not use the Keycloak web-session JWT as an API token. Keep the secret secure and do not share it.

In: header

Path Parameters

id*string

Region identifier.

Response Body

application/json

application/json

text/pain

application/json

application/json

application/json

curl -X GET "https://example.com/v1/regions/string"
{  "id": "alg1",  "country": "Algeria",  "country_id": "dz",  "flagUrl": "/static/img/flags/dz.png",  "name": "Algiers Zone A"}
{  "errors": [    {      "message": "'vcpus' field must be an integer",      "field": "resource_id"    }  ]}
"Access denied"
{  "errors": [    {      "message": "VM with ID 23 not found"    }  ]}
{  "errors": [    {      "message": "User not initialized. Send POST /v1/init, then retry the request."    }  ]}
{  "errors": [    {      "message": "VM with ID 23 not found"    }  ]}