v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

Instances

Get instance naming restrictions

Get the naming restrictions applied to instances in the specified project and region. This endpoint is deprecated.

get/cloud/v1/instances/{project_id}/{region_id}/available_names

Path parameters

project_idinteger required

Project ID

region_idinteger required

Region ID

Response

Instance naming restrictions

allowed_bm_name_templatesstring[]

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

allowed_bm_name_win_templatesstring[]

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

allowed_name_templatesstring[]

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

allowed_name_win_templatesstring[]

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

custom_name_allowedboolean required

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

name_templates_limitedboolean required

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

Example response

{
  "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}"
  ]
}