# List Single Pool

API call format

GET images/pools/{guid}         //Use token authorization
GET images/private/pools/{guid} //Use Api key

Description

List single pool

Precondition:

  • Authorization token/Api key is needed.
  • Mandatory elements:

Postcondition:

  • On success response code should be 200.
  • On success JSON formatted details for all pools are returned.
  • On failure an error will be returned with the right error code and description.

Example:

[Request] GET https://<base_api_url>/images/pools/{guid}
[Request] GET https://<base_api_url>/images/private/pools/{guid}
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","Authorization":"<IdToken>"} //Use token autorization
[Request Headers] {"Content-Type":"application/json","Accept":"application/json","X-Api-Key":"<api_key>"}     //Use Api Key

[Response] 200
[Response Headers] {"Content-Type":["application/json"],"Content-Length":["..."],"Connection":["keep-alive"],"Date":["..... GMT"],"x-amzn-RequestId":["....."],....]}
[Responce]
{
    "status": true,
    "data": {
        "guid": "<pool_guid>",
        "name": "<pool_name>",
        "bucket": "<pool_bucket_name>",
        "patterns": [
            "<pool_patterns>"
        ]
    }
}