Server list

Request Information
URL GET {{basepath}}/server?start=0&limit=10
CategoryServer
Query parameters
start0The position the list should start listing from
limit10the max number of items returned
filterOnlyMetaDatasmoketest
hostnamepleskdev.yourdomainprovider.net
statusactive
identifierplesktest
sortFieldidentifier
sortDirectiondesc
hasPackages[]basic
hasPackages[]basic_protest
hasNotPackages[]basic_protest

Example responses

Server list
Request Method & URL
GET {{basepath}}/server?start=0&limit=50
Query parameters
start0The position the list should start listing from
limit50the max number of items returned
Response Code:
200 OK
Response Body:
{
    "responseId": "1_ffa8607914cae50fd166496d374a224b4f63551b",
    "status": "ok",
    "message": "The Server list is attached",
    "listItemCount": 1,
    "server": [
        {
            "identifier": "pleskdev",
            "hostname": "pleskdev.yourdomainprovider.net",
            "type": "plesk",
            "status": "active",
            "ips": [
                {
                    "address": "213.249.70.50",
                    "version": 4
                },
                {
                    "address": "2a01:448:1004::50",
                    "version": 6
                }
            ],
            "availablePackages": [
                "basic",
                "pro"
            ],
            "usage": 748,
            "reservationWeight": 0,
            "capacity": 3000,
            "reservations": 0,
            "created": 1626259040,
            "modified": 1626259045
        }
    ]
}