# List all images
API call format
GET /images //Use token autorization
GET /images/private //Use Api Key
Description
List all images
Precondition:
- Authorization token/Api key is needed.
- Optional elements:
- w - Desired width of the image in pixels. Example format: 320
- h - Desired height of the image in pixels. Example format: 160
- d - Desired dimension of the image in pixels. Example format: 320x160
Postcondition
- On success response code should be 200
- On success JSON formatted details for all images are returned.
- On failure an error will be returned with the right error code and description.
Example:
[Request] GET https://<base_api_url>/images
[Request] GET https://<base_api_url>/images/private
[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":["....."],....]}
[Response]
{
"status": true,
"data": [
{
"guid": "<image_guid>",
"originalFileName": "<filename>.png",
"meta": {
},
"width": 1916,
"height": 922,
"format": "png",
"srcPath": "<Image path with the bucket>/image/<image_guid>/<image_guid>.png",
"cdnPath": "https://<Image full path through cdn>/images/image/<image_guid>.png",
"imageMeta": {
"depth": "uchar",
"size": 128777,
"channels": 3,
"density": 96,
"isProgressive": false,
"format": "png",
"width": 1916,
"hasProfile": false,
"space": "srgb",
"hasAlpha": false,
"height": 922
},
"hasAIMeta": false
},
{
"guid": "24458d69-aa44-4418-b896-018664498965",
"originalFileName": "jpg-0.webp",
"meta": {
},
"width": 437,
"height": 328,
"format": "webp",
"srcPath": "images_destination/image/<image_guid>/<image_guid>.png",
"cdnPath": "https://<server>/images/image/<image_guid>.png",
"imageMeta": {
"depth": "uchar",
"size": 30690,
"channels": 3,
"isProgressive": false,
"format": "webp",
"width": 437,
"hasProfile": false,
"space": "srgb",
"hasAlpha": false,
"height": 328
},
"hasAIMeta": false
},
.......
]
}
}