List images

List up to 100 images with one request. Use the optional parameters below to get a specific range of images.

application/json

Body

result

required

Any of

allOf {2}

array[object (images) {6}]

allOf {2}

One of

array[object (images) {6}]

object

filename

string

filename

read-onlyoptional

Image file name.

<= 32 characters

Example:

logo.png

string

images_components-schemas-identifier

read-onlyoptional

Image unique identifier.

<= 32 characters

Example:

107b9558-dd06-4bbd-5fef-9c2c16bb7900

metadata

object

metadata

optional

User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.

Example:

{"key":"value"}

requireSignedURLs

boolean

schemas-requireSignedURLs

optional

Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.

Default:

false

Example:

true

uploaded

string <date-time>

schemas-uploaded

read-onlyoptional

When the media item was uploaded.

Example:

2014-01-02T02:20:00Z

variants

array [anyOf]

schemas-variants

read-onlyoptional

Object specifying available variants for an image.

Example:

["https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero","https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"]

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "filename": "logo.png",
            "id": "107b9558-dd06-4bbd-5fef-9c2c16bb7900",
            "metadata": {
                "key": "value"
            },
            "requireSignedURLs": true,
            "uploaded": "2014-01-02T02:20:00Z",
            "variants": [
                "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail",
                "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero",
                "https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original"
            ]
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses