checkdomain GmbHDevelopers

Reference

Nameservers

GET /v1/domains/{domain}/nameservers

Get nameserver / zone information

Retrieve nameserver or zone information for a specific domain.

Using the www_include flag

When using the www_include flag take extra caution. If activated this will have an effect on every single nameserver record with type A, AAAA and CNAME. Those records will be duplicated and prefixed with www.

Setting an A-record to create a subdomain like api.checkdomain.de will result in having two A-records with the same priority and ttl when www_include is set to true:

  • api.checkdomain.de
  • www.api.checkdomain.de

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/domains/{domain}/nameservers
Response
HTTP/1.1 200 OK
{
    "general": {
        "ip_v4": "127.0.0.1",
        "ip_v6": "::1",
        "include_www": true
    },
    "nameservers": [
        {
            "name": "ns.checkdomain.de",
            "ip_address": "88.198.49.36"
        },
        {
            "name": "ns2.checkdomain.de",
            "ip_address": "85.214.68.241"
        }
    ],
    "mailserver": {
        "active": false,
        "ip_v4": "127.0.0.1",
        "ip_v6": "::1"
    },
    "soa": {
        "mail": "hostmaster@checkdomain.de",
        "refresh": 40000,
        "retry": 7200,
        "expiry": 604800,
        "ttl": 10800
    },
    "_links": {
        "self": {
            "href": "/v1/domains/1/nameservers"
        }
    }
}
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
Response
Name Type Required Description
general Show properties model object (General)
Properties of General
Name Type Required Description
ip_v4 string IPv4
ip_v6 string IPv6
include_www boolean Prefix nameserver A, AAAA and CNAME-records with www
nameservers Show properties collection array of objects (Nameserver)
Properties of Nameserver
Name Type Required Description
name string FQDN
ip_address string IPv4
mailserver Show properties model object (Mailserver)
Properties of Mailserver
Name Type Required Description
active boolean Active flag
ip_v4 string IPv4
ip_v6 string IPv6
soa Show properties model object (Soa)
Properties of Soa
Name Type Required Description
mail string eMail Address
refresh integer Refresh
retry integer Retry
expiry integer Expiry
ttl integer TTL
PUT /v1/domains/{domain}/nameservers

Updates nameserver or zone information

Updates nameserver or zone information for a specific domain

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --header "Content-Type: application/json" \
       --data "{Request Data}" \
       --request PUT \
       https://api.checkdomain.de/v1/domains/{domain}/nameservers
Request Data
{
    "general": {
        "ip_v4": "127.0.0.1",
        "ip_v6": "::1",
        "include_www": true
    },
    "nameservers": [
        {
            "name": "ns.checkdomain.de",
            "ip_address": "88.198.49.36"
        },
        {
            "name": "ns2.checkdomain.de",
            "ip_address": "85.214.68.241"
        }
    ],
    "mailserver": {
        "active": false,
        "ip_v4": "127.0.0.1",
        "ip_v6": "::1"
    },
    "soa": {
        "mail": "hostmaster@checkdomain.de",
        "refresh": 40000,
        "retry": 7200,
        "expiry": 604800,
        "ttl": 10800
    }
}
Response
HTTP/1.1 204 No Content
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
Parameters
Name Type Required Description
general Show properties model object (General)
Properties of General
Name Type Required Description
ip_v4 string IPv4
ip_v6 string IPv6
include_www boolean Prefix nameserver A, AAAA and CNAME-records with www
nameservers Show properties collection array of objects (Nameserver)
Properties of Nameserver
Name Type Required Description
name string FQDN
ip_address string IPv4
mailserver Show properties model object (Mailserver)
Properties of Mailserver
Name Type Required Description
active boolean Active flag
ip_v4 string IPv4
ip_v6 string IPv6
soa Show properties model object (Soa)
Properties of Soa
Name Type Required Description
mail string eMail Address
refresh integer Refresh
retry integer Retry
expiry integer Expiry
ttl integer TTL
Status-Codes
Code Description
204 Ok
400 Validation failed
404 Domain not found
500 Something on our end went wrong