Share this page

# Get Host Pool List by Query

## Description

Returns a list of host pools by query (filter).

## URL

Copy code

    /Admin/rest/v1/pools?query={<QUERY_NAME>["<YOUR_QUERY_VALUE>"]}

## Host Pool Query Values

QUERY_NAME options:

-     Name

-     ID

## Remarks

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

## HTTP Method

GET: Returns a list of host pools by query.

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

None

Request Example for pools with names that start with letter ‘T’
Copy code

    GET http://<LRE_Server>/Admin/rest/v1/pools?query={Name[T*]}
    Content-Type: application/xml
    Accept: application/xml
    Cookie: ADM_LWSSO={AdmLwssoCookie};

## Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes.

HTML Body:

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

Response Example
Copy code

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

## See Also

Host pools
Return, update, or delete a host pool by ID

Tips to improve your search results... LoadRunner Enterprise Administration REST API Reference LRE Admin REST API All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic(Undefined variable: _rscC_Basic_Variables.VersionLabel)