Get hosting object

Request Information
URL GET {{basepath}}/hosting/:hosting_id
CategoryHosting

Description

Allows you to see the current state of the hosting object including all relevant objects.

Returns a HostingGetResponse object.

Url variables
:hosting_id{{hosting_id}}The hosting identifier

Example responses

Get hosting object
Request Method & URL
GET {{basepath}}/hosting/:hosting_id
Url variables
:hosting_id{{hosting_id}}The hosting identifier
Response Code:
200 OK
Response Body:
{
    "responseId": "1_e431e4fff30f147debb60353833f64de7ac9d07c",
    "status": "ok",
    "message": "The hosting object is attached",
    "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",
        "lastMalwareScan": 1649072362,
        "created": 1628512849,
        "modified": 1628512882
    }
}
Hosting object that does not exist
Request Method & URL
GET {{basepath}}/hosting/:hosting_id
Url variables
:hosting_id{{hosting_id}}234The hosting identifier
Response Code:
404 Not Found
Response Body:
{
    "responseId": "1_75fea91cf6925736925cb38e6627e8b2cc2238e5",
    "status": "error",
    "errorCode": "does_not_exist",
    "errorMessage": "This hosting does not exist"
}
With pending hosting job
Request Method & URL
GET {{basepath}}/hosting/:hosting_id
Url variables
:hosting_id{{hosting_id}}The hosting identifier
Response Code:
200 OK
Response Body:
{
    "responseId": "1_95ff57e530975c08c70d6361951f35b46e7ec5de",
    "status": "ok",
    "message": "The hosting object is attached",
    "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": 1,
        "openJobs": [
            {
                "id": 2,
                "type": "updateHostingPackage",
                "status": "new",
                "created": 1628512942
            }
        ],
        "servicePeriod": 7,
        "serviceStatus": "active",
        "serviceRenewalMonth": 8,
        "nextServiceRenewalDate": "2021-08-16",
        "created": 1628512849,
        "modified": 1628512882,
        "metadata": {
            "smoketest": true
        }
    }
}
Get hosting object with failed job
Request Method & URL
GET {{basepath}}/hosting/:hosting_id
Url variables
:hosting_id{{hosting_id}}The hosting identifier
Response Code:
200 OK
Response Body:
{
    "responseId": "1_410c3184be54fb86c9ee6ab477d9deb2d6068713",
    "status": "ok",
    "message": "The hosting object is attached",
    "hosting": {
        "identifier": "1_aed1f3d95b069d5cdf88ef9d70392d359847e144",
        "status": "active",
        "domain": "example-2021-8-9-14-40-49.com",
        "info": {
            "serverPlan": "pro",
            "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": "pro",
            "type": "plesk",
            "status": "active",
            "spec": [
                {
                    "type": "diskspace",
                    "value": "10000"
                }
            ],
            "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": 1,
        "openJobs": [
            {
                "id": 13,
                "type": "resumeHostingService",
                "status": "failed",
                "created": 1628513819,
                "handled": 1628513819
            }
        ],
        "servicePeriod": 7,
        "serviceStatus": "active",
        "serviceRenewalMonth": 8,
        "nextServiceRenewalDate": "2021-08-16",
        "created": 1628512849,
        "modified": 1628513819
    }
}