Sign in

v1

latestOpenAPI 3.1.02026-07-2671111437.2 KB
Vanity Nameservers

Create Vanity Nameserver

Register a new vanity nameserver for the specified domain.

post/core/v1/domains/{domainName}/vanity_nameservers

Path parameters

domainNamestring hostname required
Example:example.com

The domain name to create a vanity nameserver for.

Request body

hostnamestring 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'.

ipsstring[] 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.

Example request

{
  "hostname": "ns1",
  "ips": [
    "192.168.1.10",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}

Response

Vanity nameserver successfully created.

domainNamestring 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'.

hostnamestring 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'.

ipsstring[] 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.

Example response

{
  "domainName": "example.com",
  "hostname": "ns1.example.com",
  "ips": [
    "192.168.1.1",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}