Vanity Nameservers
/
Create Vanity Nameserver

Name.com Core API (1.0.1)

RESTful API for managing domains, DNS records, and related services at Name.com. Access via HTTPS at api.name.com (production) or api.dev.name.com (testing). Supports standard authentication, rate-limited to 20 requests/second.

Download OpenAPI description
namecom.api.json
namecom.api.yaml
Overview
Account Services

accountservices@name.com

Terms of Service

Languages
Servers
Mock server

https://docs.name.com/_mock/coreapi/namecom.api/

Testing

https://api.dev.name.com/

Hello

Use the Hello endpoint to verify that your API connection and credentials are working properly. This simple call returns a success message (along with server time and version info) to confirm the API is reachable and authenticated.

Operations

Account Info

Use Account Info endpoints to retrieve basic information about your Name.com account. For example, you can check your account’s current credit balance and other account details using these endpoints.

Operations

Accounts

Use Accounts endpoints (available upon request) to manage sub-accounts under your main account. For example, resellers can programmatically create new customer accounts with their own login credentials and permissions.

Operations

Domains

Use Domains endpoints to search for domain availability, register new domains, and manage existing domains.

Operations

DNS

Use DNS endpoints to manage DNS records for your domains. You can list all existing DNS records for a domain and create, update, or delete records as needed.

Operations

DNSSECs

Use DNSSEC endpoints to configure DNS Security Extensions for your domains. These endpoints allow you to add, retrieve, or remove DNSSEC records.

Operations

Email Forwardings

Use Email Forwardings endpoints to set up and manage email forwarding addresses on your domains.

Operations

URL Forwardings

Use URL Forwardings endpoints to control URL redirection settings for your domains.

Operations

Vanity Nameservers

Use Vanity Nameservers endpoints to configure custom nameserver hostnames (glue records) for your domains.

Operations

List Vanity Nameservers

Request

Lists all vanity nameserver hostnames configured for a domain.

Path
domainNamestring(hostname)required

The domain name to list vanity nameservers for.

Example: example.com
Query
perPageinteger(int32)>= 1

The number of records to return per page. Defaults to 1000.

Default 1000
Example: perPage=50
pageinteger(int32)>= 1

The page number to return.

Default 1
Example: page=2
curl -i -X GET \
  -u <username>:<password> \
  'https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/vanity_nameservers?page=2&perPage=50'

Responses

List of vanity nameservers.

Headers
Linkstring

String delimited list of links for pagination

Example: "<https://api.dev.name.com?page=3; rel=\"next\">,<https://api.dev.name.com?page=1; rel=\"prev\">,<https://api.dev.name.com?page=10; rel=\"last\">"
Bodyapplication/json
lastPageinteger or null(int32)>= 1

LastPage is the identifier for the final page of results. It is only populated if there is another page of results after the current page. If no further pages exist, this field will be null.

Example: 5
nextPageinteger or null(int32)>= 1

NextPage is the identifier for the next page of results. It is only populated if there is another page of results after the current page. If no further pages exist, this field will be null.

Example: 2
vanityNameserversArray of objects(VanityNameserverResponse)required

VanityNameservers is the list of vanity nameservers associated with the domain. If no vanity nameservers are configured, this will be an empty array.

Example: []
vanityNameservers[].​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'.

Example: "example.com"
vanityNameservers[].​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'.

Example: "ns1.example.com"
vanityNameservers[].​ipsArray of strings(ip)non-emptyrequired

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: ["192.168.1.1","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
Response
application/json
{
  "lastPage": 5,
  "nextPage": 2,
  "vanityNameservers": []
}

Create Vanity Nameserver

Request

Register a new vanity nameserver for the specified domain.

Path
domainNamestring(hostname)required

The domain name to create a vanity nameserver for.

Example: example.com
Bodyapplication/jsonrequired

Details of the vanity nameserver to create.

hostnamestringrequired

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"
ipsArray of strings(ip)non-emptyrequired

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: ["192.168.1.10","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
curl -i -X POST \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/vanity_nameservers \
  -H 'Content-Type: application/json' \
  -d '{
    "hostname": "ns1",
    "ips": [
      "192.168.1.10",
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
    ]
  }'

Responses

Vanity nameserver successfully created.

Bodyapplication/json
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'.

Example: "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'.

Example: "ns1.example.com"
ipsArray of strings(ip)non-emptyrequired

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: ["192.168.1.1","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
Response
application/json
{
  "domainName": "example.com",
  "hostname": "ns1.example.com",
  "ips": [
    "192.168.1.1",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}

Delete Vanity Nameserver

Request

Deletes a vanity nameserver from the domain’s registry settings. This operation might fail if the registry detects the nameserver is still in use.

Path
domainNamestring(hostname)required

The domain name associated with the vanity nameserver.

Example: example.com
hostnamestring(hostname)required

The hostname of the vanity nameserver to delete.

Example: ns1.example.com
curl -i -X DELETE \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/vanity_nameservers/ns1.example.com

Responses

Vanity nameserver successfully deleted.

Response
No content

Get Vanity Nameserver

Request

Retrieves details for a of a specific vanity nameserver (including its IP addresses).

Path
domainNamestring(hostname)required

The domain name associated with the vanity nameserver.

Example: example.com
hostnamestring(hostname)required

The hostname of the vanity nameserver to retrieve.

Example: ns1.example.com
curl -i -X GET \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/vanity_nameservers/ns1.example.com

Responses

Details of the vanity nameserver.

Bodyapplication/json
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'.

Example: "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'.

Example: "ns1.example.com"
ipsArray of strings(ip)non-emptyrequired

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: ["192.168.1.1","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
Response
application/json
{
  "domainName": "example.com",
  "hostname": "ns1.example.com",
  "ips": [
    "192.168.1.1",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}

Update Vanity Nameserver IP

Request

Updates the glue record IP addresses for a vanity nameserver.

Path
domainNamestring(hostname)required

The domain name associated with the vanity nameserver.

Example: example.com
hostnamestring(hostname)required

The hostname of the vanity nameserver to update.

Example: ns1.example.com
Bodyapplication/jsonrequired

Updated IP addresses for the vanity nameserver.

ipsArray of strings(ip)>= 0 items

IPs is the updated list of IP addresses to be used for glue records for this vanity nameserver. Providing an empty array will remove all existing IPs.

Example: ["192.168.1.10","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
curl -i -X PUT \
  -u <username>:<password> \
  https://docs.name.com/_mock/coreapi/namecom.api/core/v1/domains/example.com/vanity_nameservers/ns1.example.com \
  -H 'Content-Type: application/json' \
  -d '{
    "ips": [
      "192.168.1.10",
      "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
    ]
  }'

Responses

Vanity nameserver successfully updated.

Bodyapplication/json
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'.

Example: "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'.

Example: "ns1.example.com"
ipsArray of strings(ip)non-emptyrequired

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: ["192.168.1.1","2001:0db8:85a3:0000:0000:8a2e:0370:7334"]
Response
application/json
{
  "domainName": "example.com",
  "hostname": "ns1.example.com",
  "ips": [
    "192.168.1.1",
    "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
  ]
}

Transfers

Use Transfers endpoints to move domains into your Name.com account. Start by creating a transfer request, then monitor and manage the status of pending transfers. You can also cancel a transfer if needed.

Operations

Orders

Use Orders endpoints to review and track purchases made via the API.

Operations

Webhook Notifications

Use Webhook Notification endpoints to subscribe to real-time notifications for account and domain events. This keeps your application updated on important changes without polling the API.

OperationsWebhooks