Vanity Name Server API

Vanity name servers are used to hide the use of DNSimple’s name servers and instead use our name servers with different names.

In order to enable vanity name servers you must be subscribed to a plan that grants you access that feature. Check out our plans for more details.

If you try to enable vanity name servers from a wrong plan you will get the following response:

{
  "errors": [ "Feature not enabled" ]
}

Enable domain vanity name servers

POST /domains/:domain/vanity_name_servers

Parameters

Name Type Description
:domain string, integer The domain name or id

Example

Enable vanity name servers for domain example.com.

curl  -H 'X-DNSimple-Token: <email>:<token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X POST \
      -d '<json>' \
      https://api.dnsimple.com/v1/domains/example.com/vanity_name_servers

Input

Name Type Description
vanity_nameserver_configuration.server_source string Required. Either dnsimple or external. If you pass external as the server source then you must include name servers to use. You may use up to 4 external name servers (ns1 through ns4).
Example with dnsimple source
{
  "vanity_nameserver_configuration": {
    "server_source": "dnsimple"
  }
}
Example with external source
{
  "vanity_nameserver_configuration": {
    "server_source": "external",
    "ns1": "ns1.example.com",
    "ns2": "ns2.example.com"
  }
}

Response

{
  "status": "enabled"
}

Disable domain vanity name servers

DELETE /domains/:domain/vanity_name_servers

Parameters

Name Type Description
:domain string, integer The domain name or id

Example

Disable vanity name servers for domain example.com.

curl  -H 'X-DNSimple-Token: <email>:<token>' \
      -H 'Accept: application/json' \
      -H 'Content-Type: application/json' \
      -X DELETE \
      https://api.dnsimple.com/v1/domains/example.com/vanity_name_servers

Response

{
  "status": "disabled"
}