host pools/{poolID}

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

/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:

Version 2020 (or later)

LWSSO_COOKIE_KEY={LwssoCookie};

Versions earlier than 2020

LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

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.

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