Deprovision cloud hosts

Available in versions: 12.56-12.63 only

Description

Terminates a host provisioned on the cloud.

URL

Copy code
/Admin/rest/v1/cloud/hosts/{hostID}

Remarks

Only Amazon EC2 is supported for provisioning cloud hosts using the REST API.

HTTP Method

DELETE: Frees up the cloud host.

Request

Headers:

Content-Type: application/xml

Accept: application/xml

Cookies:

Versions 2023 and later

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions 2022 - 2022 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

Versions 2021 - 2021 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

Versions 2020 - 2020 SP3

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions earlier than 2020

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

QCSession={QC_SESSION_COOKIE_VALUE};

Request Body:

DELETE: No request body.

Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

Upon successful deletion, returns HTTP status 200 (OK).

The termination operation is performed asynchronously. You can monitor the termination status using the URL provided in the response Location header. For details, see Provision host response for the response example.

HTML Body:

DELETE: No body returned

See Also

Provision cloud hosts
Get provision request
Get all provision requests
Get all cloud hosts
Audit cloud hosts
Get Cloud Account