Skip to main content
PUT
/
cloud
/
v1
/
reseller_name_templates
Update or create reseller naming configuration.
curl --request PUT \
  --url https://api.gcore.com/cloud/v1/reseller_name_templates \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "region_id": 123,
  "reseller_id": 123,
  "allow_custom_name": false,
  "allowed_bm_name_templates": [],
  "allowed_bm_name_win_templates": [],
  "allowed_lb_name_restriction": "",
  "allowed_lb_name_templates": [],
  "allowed_name_templates": [],
  "allowed_name_win_templates": []
}
'
{
  "allow_custom_name": true,
  "allowed_bm_name_templates": [
    "<string>"
  ],
  "allowed_bm_name_win_templates": [
    "<string>"
  ],
  "allowed_lb_name_restriction": "<string>",
  "allowed_lb_name_templates": [
    "<string>"
  ],
  "allowed_name_templates": [
    "<string>"
  ],
  "allowed_name_win_templates": [
    "<string>"
  ],
  "region_id": 123,
  "reseller_id": 123,
  "reseller_name": "example_reseller"
}

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

Body

application/json
​
region_id
integer
required

Restrictions are active in this region.

Example:

6

​
reseller_id
integer
required

Clients with this reseller_id are governed by this restriction setting.

Example:

123

​
allow_custom_name
boolean
default:false

Clients will be able to use "names" field and completely custom names.

Example:

false

​
allowed_bm_name_templates
string[]

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

Example:
["ed-b9-{ip_octets}"]
​
allowed_bm_name_win_templates
string[]

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

Example:
["ed-b9-{two_ip_octets}"]
​
allowed_lb_name_restriction
string
default:""

Loadbalancer name restriction.

Example:

"^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"

​
allowed_lb_name_templates
string[]

Clients will only be able to use these strings as load balancer "name_templates".

Example:
["ed-c16-lb-{ip_octets}"]
​
allowed_name_templates
string[]

Clients will only be able to use these strings as instance "name_templates".

Example:
["ed-c4-{ip_octets}"]
​
allowed_name_win_templates
string[]

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

Example:
["ed-c4-{one_ip_octet}"]

Response

200 - application/json

OK

​
allow_custom_name
boolean
required

Clients will be able to use "names" field and completely custom names.

Example:

false

​
allowed_bm_name_templates
string[]
required

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

Example:
["ed-b9-{ip_octets}"]
​
allowed_bm_name_win_templates
string[]
required

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

Example:
["ed-b9-{two_ip_octets}"]
​
allowed_lb_name_restriction
string
required

Loadbalancer name restriction.

Example:

"^[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]$"

​
allowed_lb_name_templates
string[]
required

Clients will only be able to use these strings as load balancer "name_templates".

Example:
["ed-c16-lb-{ip_octets}"]
​
allowed_name_templates
string[]
required

Clients will only be able to use these strings as instance "name_templates".

Example:
["ed-c4-{ip_octets}"]
​
allowed_name_win_templates
string[]
required

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

Example:
["ed-c4-{one_ip_octet}"]
​
region_id
integer
required

Restrictions are active in this region.

Example:

6

​
reseller_id
integer
required

Clients with this reseller_id are governed by this restriction setting.

Example:

123

​
reseller_name
string | null

Name of reseller.

Example:

"example_reseller"