Share this page

# Get Hosts List by Query

## Description

Returns a list of hosts by query (filter).

## URL

Copy code

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

## Hosts Query Values

QUERY_NAME options:

-     Name

-     ID

-     Installation

- `HostPurposes` (see note below)

-     Status

-     Attributes

-     Priority

-     SslEnabled

Note: To get hosts that have a specific purpose, but may have other purposes as well, you must surround the value with asterisks (*). For example:

`{HostPurposes['*Controller*']}`

## Remarks

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

## HTTP Method

GET: Returns a list of hosts 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
Copy code

    GET http://<LRE_Server>/Admin/rest/v1/Hosts?query={name["host name"]}
    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 Hosts response.

## See Also

Add hosts and return list of hosts
Return, delete, reconfigure, or update a host 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)