Skip to main content
GET
Get region

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

region_id
integer
required

Region ID

Example:

11

Query Parameters

show_volume_types
boolean
default:false

If true, null available_volume_type is replaced with a list of available volume types.

Example:

false

Response

200 - application/json

OK

access_level
enum<string>
required

The access level of the region.

Available options:
core,
edge
Example:

"core"

available_volume_types
string[] | null
required

List of available volume types, 'standard', 'ssd_hiiops', 'cold'].

Example:
coordinates
Coordinate · object | null
required

Coordinates of the region

Example:
country
string
required

Two-letter country code, ISO 3166-1 alpha-2

Pattern: ^\w{2}$
Example:

"LU"

created_at
string<date-time>
required

Region creation date and time

Example:

"2019-12-31T23:59:59"

created_on
string<date-time>
required
deprecated

This field is deprecated. Use created_at instead.

Example:

"2019-12-31T23:59:59"

display_name
string
required

Human-readable region name

Example:

"Luxembourg"

endpoint_type
enum<string>
required

Endpoint type

Available options:
admin,
internal,
public
Example:

"public"

external_network_id
string | null
required

External network ID for Neutron

Example:

"c843c3e6-ef4d-4b92-8db2-e16ac05c5650"

file_share_types
enum<string>[] | null
required

List of available file share types

Available options:
standard,
vast
Example:
has_ai
boolean
required

Region has AI capability

Example:

true

has_ai_gpu
boolean
required

Region has AI GPU capability

Example:

true

has_baremetal
boolean
required

Region has bare metal capability

Example:

false

has_basic_vm
boolean
required

Region has basic vm capability

Example:

false

has_dbaas
boolean
required

Region has DBAAS service

Example:

false

has_ddos
boolean
required

Region has Advanced DDoS Protection capability

Examples:

true

false

has_k8s
boolean
required

Region has managed kubernetes capability

Example:

true

has_kvm
boolean
required

Region has KVM virtualization capability

Example:

true

has_sfs
boolean
required

Region has SFS capability

Example:

false

id
integer
required

Region ID

Example:

1

keystone_id
integer
required

Foreign key to Keystone entity

Example:

1

keystone_name
string
required

Technical region name

Example:

"ED-9"

metrics_database_id
integer | null
required

Foreign key to Metrics database entity

Example:

1

slug
string
required

Short, human-readable region identifier (e.g. luxembourg-2, santa-clara-1).

Example:

"luxembourg-1"

state
enum<string>
required

Region state

Available options:
ACTIVE,
DELETED,
DELETING,
DELETION_FAILED,
INACTIVE,
MAINTENANCE,
NEW
Example:

"NEW"

task_id
string | null
required
deprecated

This field is deprecated and can be ignored

Example:

null

vlan_physical_network
string
required

Physical network name to create vlan networks

Example:

"br-ex"

zone
enum<string> | null
required

Geographical zone

Available options:
AMERICAS,
APAC,
EMEA,
RUSSIA_AND_CIS
Example:

"EMEA"

ddos_endpoint_id
integer | null
deprecated

DDoS endpoint ID

Example:

3