Get all cloud hosts

Available in versions: 12.56-12.63 only

Description

Returns a list of all hosts provisioned on the cloud.

URL

/Admin/rest/v1/cloud/hosts

Remarks

The host data can be passed as XML containing the equivalent data.

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

GET: Returns a list of provisioned hosts.

Request

Headers:

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:

GET: No request body.

Request example:

Copy code

GET http://<LRE_Server>/Admin/rest/v1/cloud/hosts HTTP/1.1
Host: PCServer
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

Content-Type: application/xml or application/json

Cookies:

None

HTML return code:

One of the HTTP return codes

Upon successful deletion, returns HTTP status 201 (Created).

HTML body:

GET: Returns the data on the provisioned hosts.

Response example: