Deprovision cloud hosts

Available in versions: 12.56-12.63 only

Description

Terminates a host provisioned on the cloud.

URL

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

Remarks

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

This API should be authorized for the Application, Tenant, and Site Admin permission levels.

HTTP method

DELETE: Frees up the cloud host.

Request

Headers:

Content-Type: application/xml
Accept: application/xml

Cookies:

Version	Cookie
2023, 24.1, and later	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};
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};
2021 - 2021 R2	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE}; ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};
2020 - 2020 SP3	ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};
Earlier than 2020	LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE}; QCSession={QC_SESSION_COOKIE_VALUE};

Request body:

DELETE: No request body.

Copy code

Request example:

DELETE http://<LRE_Server>/Admin/rest/v1/cloud/hosts/1057 HTTP/1.1
Host: PCServer
Cookie: ADM_LWSSO={AdmLwssoCookie};

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