name.com API

ListVanityNameservers

ListVanityNameservers lists all nameservers registered with the registry. It omits the IP addresses from the response. Those can be found from calling GetVanityNameserver.

Endpoint: GET /v4/domains/{domainName}/vanity_nameservers

Parameters:

domainName
(path parameters)

string

DomainName is the domain to list the vanity nameservers for.

perPage

int32

Per Page is the number of records to return per request. Per Page defaults to 1,000.

page

int32

Page is which page to return

Response:

vanityNameservers

[]*VanityNameserver


(Model Definition)

VanityNameservers is the list of vanity nameservers.

nextPage

int32

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.

lastPage

int32

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.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers'
{
    "vanityNameservers": [
        {
            "domainName": "example.org",
            "hostname": "ns1.example.org"
        }
    ]
}

GetVanityNameserver

GetVanityNameserver gets the details for a vanity nameserver registered with the registry.

Endpoint: GET /v4/domains/{domainName}/vanity_nameservers/{hostname}

Parameters:

domainName
(path parameters)

string

DomainName is the domain to for the vanity nameserver.

hostname
(path parameters)

string

Hostname is the hostname for the vanity nameserver.

Response:

domainName
(read only)

string

DomainName is the domain the nameserver is a subdomain of.

hostname

string

Hostname is the hostname of the nameserver.

ips

[]string

IPs is a list of IP addresses that are used for glue records for this nameserver.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers/ns1.example.org'
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}

CreateVanityNameserver

CreateVanityNameserver registers a nameserver with the registry.

Endpoint: POST /v4/domains/{domainName}/vanity_nameservers

Parameters:

domainName
(path parameters)

string

DomainName is the domain the nameserver is a subdomain of.

hostname
(required)

string

Hostname is the hostname of the nameserver.

ips

[]string

IPs is a list of IP addresses that are used for glue records for this nameserver.

Response:

domainName
(read only)

string

DomainName is the domain the nameserver is a subdomain of.

hostname

string

Hostname is the hostname of the nameserver.

ips

[]string

IPs is a list of IP addresses that are used for glue records for this nameserver.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers' -X POST -H 'Content-Type: application/json' --data '{"hostname":"ns1.example.org","ips":["192.168.1.1","fd01:4860:4860::8888"]}'
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}

UpdateVanityNameserver

UpdateVanityNameserver allows you to update the glue record IP addresses at the registry.

Endpoint: PUT /v4/domains/{domainName}/vanity_nameservers/{hostname}

Parameters:

domainName
(path parameters)

string

DomainName is the domain the nameserver is a subdomain of.

hostname
(path parameters)

string

Hostname is the hostname of the nameserver.

ips

[]string

IPs is a list of IP addresses that are used for glue records for this nameserver.

Response:

domainName
(read only)

string

DomainName is the domain the nameserver is a subdomain of.

hostname

string

Hostname is the hostname of the nameserver.

ips

[]string

IPs is a list of IP addresses that are used for glue records for this nameserver.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers/ns1.example.org' -X PUT -H 'Content-Type: application/json' --data '{"ips":["192.168.1.1","fd01:4860:4860::8888"]}'
{
    "domainName": "example.org",
    "hostname": "ns1.example.org",
    "ips": [
        "192.168.1.1",
        "fd01:4860:4860::8888"
    ]
}

DeleteVanityNameserver

DeleteVanityNameserver unregisteres the nameserver at the registry. This might fail if the registry believes the nameserver is in use.

Endpoint: DELETE /v4/domains/{domainName}/vanity_nameservers/{hostname}

Parameters:

domainName
(path parameters)

string

DomainName is the domain of the vanity nameserver to delete.

hostname
(path parameters)

string

Hostname is the hostname of the vanity nameserver to delete.

Response:

Empty response.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/vanity_nameservers/ns1.example.org' -X DELETE
{}