Skip to main content
POST
/
core
/
v1
/
domains
/
{domainName}
/
vanity_nameservers
Create Vanity Nameserver
curl --request POST \
  --url https://api.dev.name.com/core/v1/domains/{domainName}/vanity_nameservers \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "hostname": "ns1",
  "ips": [
    "192.168.1.10",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}'
{
  "domainName": "example.com",
  "hostname": "ns1.example.com",
  "ips": [
    "192.168.1.1",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}

Authorizations

Authorization
string
header
required

Authenticate via HTTP Basic with your account username and API token. Examples use an explicit 'Authorization: Basic <base64(username:token)>' header; 'curl -u username:token' is equivalent. For sandbox, append "-test" to your username and use your sandbox token on api.dev.name.com.

Path Parameters

domainName
string<hostname>
required

The domain name to create a vanity nameserver for.

Example:

"example.com"

Body

application/json

Details of the vanity nameserver to create.

VanityNameserver contains the hostname as well as the list of IP addresses for nameservers.

hostname
string
required

The subdomain portion of the nameserver hostname. The domain portion will be taken from the URL path. For example, to create 'ns1.example.com', specify 'ns1' when calling the endpoint for the domain 'example.com'.

Example:

"ns1"

ips
string<ip>[]
required

IPs is a list of IP addresses that are used for glue records for this nameserver. These should be valid IPv4 or IPv6 addresses.

Minimum length: 1
Example:
[
"192.168.1.10",
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
]

Response

Vanity nameserver successfully created.

VanityNameserver response schema with full hostname VanityNameserver represents a custom nameserver associated with a domain, including its hostname and a list of IP addresses for glue records.

domainName
string<hostname>
required

DomainName is the root domain for which this vanity nameserver is created. For example, if the hostname is 'ns1.example.com', the domainName would be 'example.com'.

Example:

"example.com"

hostname
string<hostname>
required

Hostname is the fully qualified domain name (FQDN) of the vanity nameserver. It must be a subdomain of the domain specified in 'domainName'.

Example:

"ns1.example.com"

ips
string<ip>[]
required

IPs is a list of IP addresses that are used for glue records for this vanity nameserver. These should be valid IPv4 or IPv6 addresses.

Minimum length: 1
Example:
[
"192.168.1.1",
"2001:0db8:85a3:0000:0000:8a2e:0370:7334"
]
I