Share this page

# Return, delete, reconfigure, or update a host by ID

## Description

Returns, deletes, reconfigures, or updates a host (per the specified host ID).

To get host information, an HTTP request should be sent to the URL returned in the Location header of the response of the Host entity creation (see Add hosts and return list of hosts) or the URL can be composed by concatenating the returned Host ID to the URL that was used for the Host creation. For existing hosts in LAB_MANAGEMENT project, you can concatenate the value in the “Host ID” field to the URL that was used for the Host creation.

## URL

Copy code

    /Admin/rest/v1/hosts/{hostID}

## Remarks

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

## HTTP Method

GET: Returns the host information.

POST: Reconfigures the host.

PATCH: Updates the host.

DELETE: Deletes the host.

## 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, POST, DELETE: No request body.

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

Request Example - GET
Copy code

    GET http://<LRE_Server>/Admin/rest/v1/hosts/1402
    Content-Type: application/xml
    Accept: application/xml
    Cookie: ADM_LWSSO={AdmLwssoCookie};

Request Example - POST
Copy code

    POST http://<LRE_Server>/Admin/rest/v1/hosts/1001/reconfigure
    Content-Type: application/xml
    Accept: application/xml
    Cookie: ADM_LWSSO={AdmLwssoCookie};

Request Example - PATCH
Copy code

    PATCH http://<LRE_Server>/Admin/rest/v1/hosts/1029
    Content-Type: application/xml
    Accept: application/xml
    Cookie: ADM_LWSSO={AdmLwssoCookie};

    <LabHost>
      <Pools>
        <PoolID>1000</PoolID>
        <PoolID>1001</PoolID>
      </Pools>
    </LabHost>

## Response

Headers:

None

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes.

Upon successful deletion, returns HTTP status 200 (OK).

HTML Body:

GET, POST: Returns the data on the entity in the response. See Hosts response.

DELETE, PATCH: No body returned.

## See Also

Add hosts and return list of hosts
Get Hosts List by Query

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)