hosts/{hostID}
Description
Returns, deletes, reconfigures, or updates a host (per the specified hostID).
To get host information, an HTTP request should be sent to the URL returned in the Location header of the response of the Host entity creation (see hosts) or the URL can be composed by concatenating the returned Host ID to the URL that was used for the Host creation. For existing hosts in LAB_MANAGEMENT project, you can concatenate the value in the “Host ID” field to the URL that was used for the Host creation.
URL
/Admin/rest/v1/hosts/{hostID}
Remarks
The host data can be passed as XML containing the equivalent data.
HTTP Method
GET: Returns the host information.
POST: Reconfigures the host.
PATCH: Updates the host.
DELETE: Deletes the host.
Request
Headers:
Content-Type: application/xml
Accept: application/xml
Cookies:
Version 2020 (or later) | LWSSO_COOKIE_KEY={LwssoCookie}; |
Versions earlier than 2020 | LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie}; |
Request Body:
GET, POST, DELETE: No request body.
PATCH: An XML describing the host property to be updated in the host.

GET http://<LRE_Server>/Admin/rest/v1/hosts/1402 Content-Type: application/xml Accept: application/xml Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

POST http://<LRE_Server>/Admin/rest/v1/hosts/1001/reconfigure Content-Type: application/xml Accept: application/xml Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

PATCH http://<LRE_Server>/Admin/rest/v1/hosts/1029 Content-Type: application/xml Accept: application/xml Cookie: LWSSO_COOKIE_KEY={LwssoCookie}; <LabHost> <Pools> <PoolID>1000</PoolID> <PoolID>1001</PoolID> </Pools> </LabHost>
Response
Headers:
None
Cookies:
None
HTML Return Code:
One of the HTTP Return Codes.
Upon successful deletion, returns HTTP status 200 (OK).
HTML Body:
GET, POST: Returns the data on the entity in the response. See hosts response.
DELETE, PATCH: No body returned.
See Also