checkdomain GmbHDevelopers

Reference

Configurations

GET /v1/servers/configurations

List package configurations

Returns a list of all available package configurations

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/servers/configurations
Response
HTTP/1.1 200 OK
{
    "page": 1,
    "limit": 10,
    "pages": 1,
    "total": 2,
    "_links": {
        "self": {
            "href": "/v1/servers/configurations/?page=1&limit=10"
        },
        "first": {
            "href": "/v1/servers/configurations/?page=1&limit=10"
        },
        "last": {
            "href": "/v1/servers/configurations/?page=1&limit=10"
        }
    },
    "_embedded": {
        "configurations": [
            {
                "id": 1,
                "name": "Starter-Paket",
                "used": 2,
                "shell_exec": false,
                "disc_space_limit": {
                    "value": 500,
                    "unit": "MB"
                },
                "domain_limit": {
                    "value": 0
                },
                "mail_limit": {
                    "value": 128
                },
                "db_limit": {
                    "value": 0
                },
                "cron_limit": {
                    "value": 0
                },
                "max_exec_time": {
                    "value": 0,
                    "unit": "SEC"
                },
                "ftp_limit": {
                    "value": 5
                },
                "php_mem_limit": {
                    "value": 128,
                    "unit": "MB"
                },
                "_links": {
                    "self": {
                        "href": "/v1/servers/configurations/1"
                    }
                }
            },
            {
                "id": 2,
                "name": "Super-Paket",
                "used": 0,
                "shell_exec": false,
                "disc_space_limit": {
                    "value": 5000,
                    "unit": "MB"
                },
                "domain_limit": {
                    "value": 0
                },
                "mail_limit": {
                    "value": 256
                },
                "db_limit": {
                    "value": 0
                },
                "cron_limit": {
                    "value": 0
                },
                "max_exec_time": {
                    "value": 0,
                    "unit": "SEC"
                },
                "ftp_limit": {
                    "value": 5
                },
                "php_mem_limit": {
                    "value": 256,
                    "unit": "MB"
                },
                "_links": {
                    "self": {
                        "href": "/v1/servers/configurations/2"
                    }
                }
            }
        ]
    }
}
Response
Name Type Required Description
root Show properties collection Yes array of objects (Configuration)
Properties of Configuration
Name Type Required Description
id integer Configuration identifier
name string Configuration name
used integer Count of usage
shell_exec boolean Php shell execution allowed or not
disc_space_limit Show properties model object (Value)
Properties of Value
Name Type Required Description
value integer Value
unit string Values unit
domain_limit object (Value) Configured limit of domains
mail_limit object (Value) Configured limit of email accounts
db_limit object (Value) Configured limit of databases
cron_limit object (Value) Configured limit of cronjobs
max_exec_time object (Value) Configured php max_execution_time
ftp_limit object (Value) Configured limit of ftp accounts
php_mem_limit object (Value) Configured php memory_limit
Status-Codes
Code Description
200 Ok
404 Server not found
500 Something on our end went wrong
GET /v1/servers/configurations/{configuration}

Get package configuration

Returns a single package configuration by identifier

Example
$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/servers/configurations/{configuration}
Response
HTTP/1.1 200 OK
{
    "id": 1,
    "name": "Starter-Paket",
    "used": 2,
    "shell_exec": false,
    "disc_space_limit": {
        "value": 500,
        "unit": "MB"
    },
    "domain_limit": {
        "value": 0
    },
    "mail_limit": {
        "value": 128
    },
    "db_limit": {
        "value": 0
    },
    "cron_limit": {
        "value": 0
    },
    "max_exec_time": {
        "value": 0,
        "unit": "SEC"
    },
    "ftp_limit": {
        "value": 5
    },
    "php_mem_limit": {
        "value": 128,
        "unit": "MB"
    },
    "_links": {
        "self": {
            "href": "/v1/servers/configurations/1"
        }
    }
}
Requirements
Name Type Required Description
configuration integer (\d+) Configuration identifier
Response
Name Type Required Description
id integer Configuration identifier
name string Configuration name
used integer Count of usage
shell_exec boolean Php shell execution allowed or not
disc_space_limit Show properties model object (Value)
Properties of Value
Name Type Required Description
value integer Value
unit string Values unit
domain_limit object (Value) Configured limit of domains
mail_limit object (Value) Configured limit of email accounts
db_limit object (Value) Configured limit of databases
cron_limit object (Value) Configured limit of cronjobs
max_exec_time object (Value) Configured php max_execution_time
ftp_limit object (Value) Configured limit of ftp accounts
php_mem_limit object (Value) Configured php memory_limit
Status-Codes
Code Description
200 Ok
404 Server not found
500 Something on our end went wrong