Return, update, or delete a host pool by ID

Description

Returns, updates, or deletes a host pool (per the specified poolID).

  • To get host pool information, an HTTP request should be sent to the URL returned in the Location header of the response of the Host Pool entity creation (see Host pools) or the URL can be composed by concatenating the returned PoolID to the URL that was used for the Host Pool creation. For existing host pools in LAB_MANAGEMENT project, you can concatenate the value in the “Pool ID” field to the URL that was used for the Host Pool creation.
  • To delete a host pool, an HTTP request should be sent to the URL below.

URL

Copy code
/Admin/rest/v1/pools/{poolID}

Remarks

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

HTTP Method

GET: Returns the host pool information.

PATCH: Updates the host pool.

DELETE: Deletes the host pool.

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:

GET, DELETE: No request body.

PATCH: An XML describing the data to be updated in the host pool.

An XML describing the host pool.

Copy code
GET http://<LRE_Server>/Admin/rest/v1/pools/1000
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
PATCH http://<LRE_Server>/Admin/rest/v1/pools/1000
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

<HostPool> 
  <Description>Some new description</Description>
  <Hosts>
    <HostID>10</HostID>
  </Hosts>
</HostPool> 

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).

HTML Body:

GET: Returns the data on the entity in the response. See Host pool response.

DELETE, PATCH: No body returned.

See Also

Host pools