Open topic with navigation

# Get Docker Host Image

Available in versions: 12.62 and later

## Description

Returns a list of images available to the project; the list can be filtered to retun all images, or Controller or load generator images only.

## URL

Returns all available Docker images in the assigned orchestrator:

    /LoadTest/rest/domains/{domainName}/projects/{projectName}/dockerimages

Returns all Docker Controller images in the assigned orchestrator:

    /LoadTest/rest/domains/{domainName}/projects/{projectName}/dockerimages/controller

Returns all Docker load generator images in the assigned orchestrator:

    /LoadTest/rest/domains/{domainName}/projects/{projectName}/dockerimages/loadgenerator

## Remarks

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

## HTTP Method

GET: Returns a list of Docker images by query.

## Request

Headers:

Content-Type: application/xml

Cookies:

Version 2020 (or later) | LWSSO_COOKIE_KEY={LwssoCookie};
Versions earlier than 2020 | LWSSO_COOKIE_KEY={LwssoCookie};QCSession={QCSessionCookie};

Request Body:

None

Request Example

    GET http://<LRE_Server>/LoadTest/rest/domains/{domainName}/projects/{projectName}/dockerimages/loadgenerator
    Content-Type: application/xml
    Cookie: LWSSO_COOKIE_KEY={LwssoCookie};

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

Response Example

    <DockerImages xmlns="http://www.hp.com/PC/REST/API">
      <DockerImage>
         <ID>1000</ID>
         <Name>performancetesting/load_generator_linux</Name>
         <Type>UNIX</Type>
         <Description>Default image for LoadRunner Enterprise Linux Load Generator</Description>
         <IsDefault>Y</IsDefault>
      <DockerImage>
      <DockerImage>
         <ID>1003</ID>
         <Name>controller_linux:12.60</Name>
         <Type>UNIX</Type>
         <Description />
         <IsDefault>N</IsDefault>
         <Purpose>Controller</Purpose>
      </DockerImage>
    </DockerImages>

## See Also

hosts