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 created 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
/Admin/rest/v1/pools/{poolID}
Remarks
The host pool data can be passed as XML or JSON containing the equivalent data.
HTTP Method
GET: Returns the host pool information.
PATCH: Updates the host pool.
DELETE: Deletes the host pool.
Request
Headers:
One of the following:
Content-Type: application/xml
Content-Type: application/json
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: XML or JSON describing the data to be updated in the host pool.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
GET http://<LRE_Server>/Admin/rest/v1/pools/1000
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
GET http://<LRE_Server>/Admin/rest/v1/pools/1000
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
DELETE http://<LRE_Server>/Admin/rest/v1/pools/1000
Cookie: ADM_LWSSO={AdmLwssoCookie};
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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>
PATCH http://<LRE_Server>/Admin/rest/v1/pools/1000
Content-Type: application/json
Accept: application/json
Cookie: ADM_LWSSO={AdmLwssoCookie};
{
"Description": "Description was updated with REST",
"Hosts":
[
1808,
1100
]
}
Response
Headers:
One of:
Accept: application/xml
Accept: application/json
Cookies:
None
HTML Return Code:
One of the HTTP Return Codes
HTML Body:
GET: Returns the data on the entity in the response. The fields in the response are:
Element | Description |
---|---|
HostPools | The top-level element. Contains HostPool sub elements with the elements listed below. |
Name | The name of the host pool. |
Description | An optional description of the host pool. |
Hosts | Can contain HostID sub elements which lists the ID of the hosts assigned to the pool. |
ID | The ID of the host pool. |
DELETE, PATCH: No body returned.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<HostPools>
<HostPool>
<Name>TestPool</Name>
<Description>Some description</Description>
<ID>1001</ID>
</HostPool>
<HostPool>
<Name>TestPool2</Name>
<Description>Some description</Description>
<Hosts>
<HostID>1026</HostID>
<HostID>1029</HostID>
</Hosts>
<ID>1002<ID>
</HostPool>
<HostPool>
<Name>TestPool4</Name>
<Description>Some description</Description>
<ID>1003</ID>
</HostPool>
</HostPools>
{
"ID": 1135,
"Name": "Pool_REST",
"Description": "Description was updated with REST",
"Hosts": [
1100,
1808
]
}
See Also