Name.com API Documentation

API

ListDNSSECs

ListDNSSECs lists all of the DNSSEC keys registered with the registry.

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

Parameters:

domainName
(path parameters)

string

DomainName is the domain name to list keys for.

Response:

dnssec

[]*DNSSEC

(Model Definition)

Dnssec is the list of registered DNSSEC keys.

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/dnssec'

{
    "dnssec": [
        {
            "domainName": "example.org",
            "keyTag": 30909,
            "algorithm": 8,
            "digestType": 2,
            "digest": "E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"
        }
    ]
}

GetDNSSEC

GetDNSSEC retrieves the details for a key registered with the registry.

Endpoint: GET /v4/domains/{domainName}/dnssec/{digest}

Parameters:

domainName
(path parameters)

string

DomainName is the domain name.

digest
(path parameters)

string

Digest is the digest for the DNSKEY RR to retrieve.

Response:

domainName
(read only)

string

DomainName is the domain name.

keyTag

int32

KeyTag contains the key tag value of the DNSKEY RR that validates this signature. The algorithm to generate it is here: https://tools.ietf.org/html/rfc4034#appendix-B

algorithm

int32

Algorithm is an integer identifying the algorithm used for signing. Valid values can be found here: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml

digestType

int32

DigestType is an integer identifying the algorithm used to create the digest. Valid values can be found here: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml

digest

string

Digest is a digest of the DNSKEY RR that is registered with the registry.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/dnssec/E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766'

{
    "domainName": "example.org",
    "keyTag": 30909,
    "algorithm": 8,
    "digestType": 2,
    "digest": "E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"
}

CreateDNSSEC

CreateDNSSEC registers a DNSSEC key with the registry.

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

Parameters:

domainName
(path parameters)

string

DomainName is the domain name.

keyTag

int32

KeyTag contains the key tag value of the DNSKEY RR that validates this signature. The algorithm to generate it is here: https://tools.ietf.org/html/rfc4034#appendix-B

algorithm

int32

Algorithm is an integer identifying the algorithm used for signing. Valid values can be found here: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml

digestType

int32

DigestType is an integer identifying the algorithm used to create the digest. Valid values can be found here: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml

digest

string

Digest is a digest of the DNSKEY RR that is registered with the registry.

Response:

domainName
(read only)

string

DomainName is the domain name.

keyTag

int32

KeyTag contains the key tag value of the DNSKEY RR that validates this signature. The algorithm to generate it is here: https://tools.ietf.org/html/rfc4034#appendix-B

algorithm

int32

Algorithm is an integer identifying the algorithm used for signing. Valid values can be found here: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml

digestType

int32

DigestType is an integer identifying the algorithm used to create the digest. Valid values can be found here: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml

digest

string

Digest is a digest of the DNSKEY RR that is registered with the registry.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/dnssec' -X POST -H 'Content-Type: application/json' --data '{"keyTag":30909,"algorithm":8,"digestType":2,"digest":"E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"}'

{
    "domainName": "example.org",
    "keyTag": 30909,
    "algorithm": 8,
    "digestType": 2,
    "digest": "E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766"
}

DeleteDNSSEC

DeleteDNSSEC removes a DNSSEC key from the registry.

Endpoint: DELETE /v4/domains/{domainName}/dnssec/{digest}

Parameters:

domainName
(path parameters)

string

DomainName is the domain name the key is registered for.

digest
(path parameters)

string

Digest is the digest for the DNSKEY RR to remove from the registry.

Response:

Empty response.

Example:

curl -u 'username:token' 'https://api.dev.name.com/v4/domains/example.org/dnssec/E2D3C916F6DEEAC73294E8268FB5885044A833FC5459588F4A9184CFC41A5766' -X DELETE

{}