checkdomain GmbHDevelopers

Reference

Servers

GET /v1/servers

List servers

Returns all available servers in a list.

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/servers
Response
HTTP/1.1 200 OK
{
    "page": 1,
    "limit": 10,
    "pages": 1,
    "total": 2,
    "_links": {
        "self": {
            "href": "/v1/servers?page=1&limit=10"
        },
        "first": {
            "href": "/v1/servers?page=1&limit=10"
        },
        "last": {
            "href": "/v1/servers?page=1&limit=10"
        }
    },
    "_embedded": {
        "servers": [
            {
                "id": 1,
                "name": "M1010504",
                "order_date": "2017-09-01T00:00:00+0200",
                "ip_address": "94.130.2.202",
                "billing": {
                    "begin": "2017-09-02T00:00:00+0200",
                    "cleared_until": null,
                    "period": 1
                },
                "_links": {
                    "self": {
                        "href": "/v1/servers/1"
                    }
                }
            },
            {
                "id": 2,
                "name": "M1010505",
                "order_date": "2017-10-19T00:00:00+0200",
                "ip_address": "94.130.88.69",
                "billing": {
                    "begin": "2017-10-19T00:00:00+0200",
                    "cleared_until": "2017-11-19T00:00:00+0100",
                    "period": 1
                },
                "_links": {
                    "self": {
                        "href": "/v1/servers/2"
                    }
                }
            }
        ]
    }
}
Filters
Name Type Required Description
page integer Page number
limit integer Items per page
Response
Name Type Required Description
root Show properties collection Yes array of objects (ManagedServer)
Properties of ManagedServer
Name Type Required Description
id integer Server identifier
name string Server name
order_date DateTime Date of order
ip_address string IPv4 Address
billing Show properties model object (Billing)
Properties of Billing
Name Type Required Description
begin DateTime Billing begin
cleared_until DateTime Billing cleared until
period integer Billing period (month)
Status-Codes
Code Description
200 Ok
500 Something on our end went wrong
GET /v1/servers/{server}

Get server

Returns a single server by identifier

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/servers/{server}
Response
HTTP/1.1 200 OK
{
    "id": 2,
    "name": "M1010505",
    "order_date": "2017-10-19T00:00:00+0200",
    "ip_address": "94.130.88.69",
    "billing": {
        "begin": "2017-10-19T00:00:00+0200",
        "cleared_until": "2017-11-19T00:00:00+0100",
        "period": 1
    },
    "disc_space": {
        "reserved": {
            "limit": 480,
            "used": 24,
            "unit": "MB"
        },
        "backup": {
            "limit": 480,
            "used": 0,
            "unit": "MB"
        },
        "database": {
            "limit": 480,
            "used": 0,
            "unit": "MB"
        },
        "ftp_mail": {
            "limit": 480,
            "used": 0,
            "unit": "MB"
        }
    },
    "_links": {
        "self": {
            "href": "/v1/servers/2"
        }
    }
}
Requirements
Name Type Required Description
server integer (\d+) Server identifier
Response
Name Type Required Description
id integer Server identifier
name string Server name
order_date DateTime Date of order
ip_address string IPv4 Address
billing Show properties model object (Billing)
Properties of Billing
Name Type Required Description
begin DateTime Billing begin
cleared_until DateTime Billing cleared until
period integer Billing period (month)
disc_space Show properties model object (DiscSpace)
Properties of DiscSpace
Name Type Required Description
reserved Show properties model object (Space)
Properties of Space
Name Type Required Description
limit integer Total space
used integer Used space
value integer Value
unit string Values unit
backup object (Space)
database object (Space) Databases space
ftp_mail object (Space) FTP/EMail space
Status-Codes
Code Description
200 Ok
404 Server not found
500 Something on our end went wrong