# List All Pools
API call format
GET images/pools //Use token authorization
GET images/private/pools //Use Api key
Description
List all pools
Precondition:
- Authorization token/Api key is needed.
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
[Request] GET https://<base_api_url>/images/private/pools
[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>"
]
},
{
"guid": "ca3b1da7-32e4-4560-a2fb-81ef955e0cc1",
"name": "cats",
"bucket": "cats-bucket",
"patterns": [
"^fluffy-cats/",
".png$"
]
},
.......
]
}