Skip to main content
GET
/
cloud
/
v1
/
instances
/
{project_id}
/
{region_id}
/
available_names
Get instance naming restrictions
curl --request GET \
  --url https://api.gcore.com/cloud/v1/instances/{project_id}/{region_id}/available_names \
  --header 'Authorization: <api-key>'
{
  "allowed_bm_name_templates": [
    "ed-b9-{ip_octets}"
  ],
  "allowed_name_templates": [
    "ed-c4-{ip_octets}"
  ],
  "custom_name_allowed": false,
  "name_templates_limited": true,
  "allowed_name_win_templates": [
    "ed-b9-{one_ip_octet}"
  ],
  "allowed_bm_name_win_templates": [
    "ed-c4-{two_ip_octets}"
  ]
}

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

​
project_id
integer
required

Project ID

​
region_id
integer
required

Region ID

Response

200 - application/json

Instance naming restrictions

Instance naming restrictions.

​
custom_name_allowed
boolean
required

If true, instances can be created using "names" field.

​
name_templates_limited
boolean
required

If true, only specific strings are allowed in "name_templates" fields.

​
allowed_bm_name_templates
string[]

Clients will only be able to use these strings as bare metal server "bm_name_templates".

​
allowed_bm_name_win_templates
string[]

Clients will only be able to use these strings as bare metal server "bm_name_templates".

​
allowed_name_templates
string[]

If "name_templates_limited" is True, this is the list of allowed instance name templates.

​
allowed_name_win_templates
string[]

If "name_templates_limited" is True, this is the list of allowed windows instance name templates.