checkdomain GmbHDevelopers

Reference

Records

GET /v1/domains/{domain}/nameservers/records

List nameserver records

Returns all nameserver records for the specific domain

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/domains/{domain}/nameservers/records
Response
HTTP/1.1 200 OK
{
    "page": 1,
    "limit": 10,
    "pages": 1,
    "total": 6,
    "_links": {
        "self": {
            "href": "/v1/domains/1/nameservers/records?page=1&limit=10"
        },
        "first": {
            "href": "/v1/domains/1/nameservers/records?page=1&limit=10"
        },
        "last": {
            "href": "/v1/domains/1/nameservers/records?page=1&limit=10"
        }
    },
    "_embedded": {
        "records": [
            {
                "name": "@",
                "value": "127.0.0.2",
                "ttl": 180,
                "priority": 0,
                "type": "A"
            },
            {
                "name": "@",
                "value": "::1",
                "ttl": 180,
                "priority": 0,
                "type": "AAAA"
            },
            {
                "name": "",
                "value": "ns2.checkdomain.de",
                "ttl": 180,
                "priority": 0,
                "type": "NS"
            },
            {
                "name": "",
                "value": "ns1.checkdomain.de",
                "ttl": 180,
                "priority": 0,
                "type": "NS"
            },
            {
                "name": "testdomain.de",
                "value": "IN SOA ns2.checkdomain.de. hostmaster@checkdomain.de. 45000 7500 654800",
                "ttl": 15800,
                "priority": 0,
                "type": "SOA"
            },
            {
                "name": "subdomain",
                "value": "127.0.0.3",
                "ttl": 180,
                "priority": 0,
                "type": "A",
                "_links": {
                    "self": {
                        "href": "/v1/domains/1/nameservers/records/22"
                    }
                }
            }
        ]
    }
}
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
Filters
Name Type Required Description
type string DNS Record Type
page integer Page number
limit integer Items per page
Response
Name Type Required Description
root Show properties collection Yes array of objects (Record)
Properties of Record
Name Type Required Description
name string Record name
value string Record value
ttl float Time to live
priority float Priority
type string Record type
Status-Codes
Code Description
200 Ok
404 Domain not found
500 Something on our end went wrong
GET /v1/domains/{domain}/nameservers/records/{record}

Get Record

Returns a single record by identifier

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/domains/{domain}/nameservers/records/{record}
Response
HTTP/1.1 200 OK
{
    "name": "subdomain",
    "ttl": 180,
    "type": "A",
    "priority": 0,
    "value": "127.0.0.3",
    "_links": {
        "self": {
            "href": "/v1/domains/1/nameservers/records/22"
        }
    }
}
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
record integer (\d+) Record identifier
Response
Name Type Required Description
name string Record name
value string Record value
ttl float Time to live
priority float Priority
type string Record type
Status-Codes
Code Description
200 Ok
404 Record / Domain not found
500 Something on our end went wrong

Post

Creates a new nameserver record

POST /v1/domains/{domain}/nameservers/records

Creates a new nameserver record

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --header "Content-Type: application/json" \
       --data "{Request Data}" \
       --request POST \
       https://api.checkdomain.de/v1/domains/{domain}/nameservers/records
Request Data
{
    "name": "subdomain",
    "ttl": 180,
    "type": "A",
    "priority": 0,
    "value": "127.0.0.3"
}
Response
HTTP/1.1 201 Created
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
Parameters
Name Type Required Description
name string Record name
value string Record value
ttl float Time to live
priority float Priority
type string Record type
Status-Codes
Code Description
201 Ok
400 Validation failed
404 Domain not found
500 Something on our end went wrong
PUT /v1/domains/{domain}/nameservers/records

Replaces all nameserver records

Caution

This command replaces all existing nameserver records with new ones

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/records
Request Data
[
    {
        "name": "subdomain",
        "ttl": 180,
        "type": "A",
        "priority": 0,
        "value": "127.0.0.3"
    },
    {
        "name": "subdomain",
        "ttl": 180,
        "type": "A",
        "priority": 0,
        "value": "127.0.0.4"
    }
]
Response
HTTP/1.1 204 No Content
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
Parameters
Name Type Required Description
root Show properties collection Yes array of objects (Record)
Properties of Record
Name Type Required Description
name string Record name
value string Record value
ttl float Time to live
priority float Priority
type string Record type
Status-Codes
Code Description
204 No Content
400 Validation failed
404 Domain not found
500 Something on our end went wrong
PUT /v1/domains/{domain}/nameservers/records/{record}

Updates a single nameserver record

Updates a single nameserver record by domain and record identifier

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/records/{record}
Request Data
{
    "name": "subdomain",
    "ttl": 180,
    "type": "A",
    "priority": 0,
    "value": "127.0.0.3"
}
Response
HTTP/1.1 204 No Content
Requirements
Name Type Required Description
domain integer (\d+) Domain identifier
record integer (\d+) Record identifier
Parameters
Name Type Required Description
name string Record name
value string Record value
ttl float Time to live
priority float Priority
type string Record type
Status-Codes
Code Description
204 No Content
400 Validation failed
404 Record / Domain not found
500 Something on our end went wrong