Cancels a hosting

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

Description

Allows you to cancel a hosting, this will expire at the end of the service period.

the request body should contain a HostingCancelRequest object.

Returns a HostingGetResponse object.

Url variables
:hosting_id{{hosting_id}}The hosting identifier
JSON
{
    "reason": "e.g. an order id or cancellation id or something, this is logged for conflict resolution purposes",
    "domain": "{{hosting_domain}}",
    "immediate": false
}

Example responses

Cancel the service for hosting
Request Method & URL
DELETE {{basepath}}/hosting/:hosting_id
Request Body:
{
    "reason": "e.g. an order id or cancellation id or something, this is logged for conflict resolution purposes",
    "domain": "example-2021-7-23-11-12-52.com"
}
Url variables
:hosting_id{{hosting_id}}The hosting identifier
Response Code:
202 Accepted
Response Body:
{
    "responseId": "1_2aa01b5ded29ce1e099896b7508af8526249cc9e",
    "status": "pending",
    "message": "Your cancel request is pending",
    "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": 0,
        "servicePeriod": 7,
        "serviceStatus": "active",
        "serviceRenewalMonth": 8,
        "nextServiceRenewalDate": "2021-08-16",
        "created": 1628512849,
        "modified": 1628513631
    }
}
Hosting is already cancelled
Request Method & URL
DELETE {{basepath}}/hosting/:hosting_id
Request Body:
{
    "reason": "e.g. an order id or cancellation id or something, this is logged for conflict resolution purposes",
    "domain": "example.com"
}
Url variables
:hosting_id{{hosting_id}}The hosting identifier
Response Code:
405 Method Not Allowed
Response Body:
{
    "responseId": "1_7fb724a34941c7cd98105f94ba82cbd829af63be",
    "status": "error",
    "errorCode": "not_active",
    "errorMessage": "This service for this hosting is not in an active state you cannot cancel this service"
}