Get hosting list

Request Information
URL GET {{basepath}}/hosting?start=0&limit=50&status=active
CategoryHosting

Description

Lists the hosting objects in the system. Returns a HostingListResponse object.

Query parameters
start0
limit50
statusactive
packageplus
crmIdcrm-1

Example responses

Get hosting list
Request Method & URL
GET {{basepath}}/hosting?start=0&limit=50&status=active&package=basic1&server=plesktest
Query parameters
start0The start of the search request
limit50Maximum number of results
statusactiveThe status to search for. For now the following statusses are allowed active,provisioning,failed,deleted
packagebasic1The name of the package you want to search for
serverplesktestThe name of the server you want to search for
Response Code:
200 OK
Response Body:
{
    "responseId": "1_4f56d400ec11ad84b35348b7bcd05c138264de76",
    "status": "ok",
    "message": "The Hosting list is attached",
    "listItemCount": 1,
    "hosting": [
        {
            "identifier": "1_aed1f3d95b069d5cdf88ef9d70392d359847e144",
            "status": "active",
            "domain": "example-2021-8-9-14-40-49.com",
            "info": {
                "serverPlan": "basic",
                "pleskUser": "h_00000001",
                "pleskFtpUser": "f_00000001",
                "pleskClientId": 282,
                "pleskHostingId": 235,
                "activeDomains": 1,
                "subdomains": 0,
                "diskspace": 0,
                "databases": 0,
                "traffic": 0,
                "trafficPrevDay": 0
            },
            "options": [
                {
                    "name": "letsEncrypt",
                    "value": "disabled",
                    "arguments": []
                }
            ],
            "package": {
                "packageId": "basic",
                "type": "plesk",
                "status": "active",
                "spec": [
                    {
                        "type": "diskspace",
                        "value": "1000"
                    }
                ],
                "created": 1626272615,
                "modified": 1626272619
            },
            "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": 1,
                "capacity": 20,
                "created": 1626259040,
                "modified": 1626259045
            },
            "suspended": false,
            "renewalDay": 9,
            "period": 1,
            "nextRenewal": "2021-08-10",
            "openJobCount": 0,
            "servicePeriod": 7,
            "serviceStatus": "active",
            "serviceRenewalMonth": 8,
            "nextServiceRenewalDate": "2021-08-16",
            "created": 1628512849,
            "modified": 1628512882,
            "metadata": {
                "smoketest": true
            }
        }
    ]
}