--- title: Images --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Images #### ImagesV1 ##### [List images](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/list) Deprecated GET/accounts/{account\_id}/images/v1 ##### [Image details](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/get) GET/accounts/{account\_id}/images/v1/{image\_id} ##### [Upload an image](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/create) POST/accounts/{account\_id}/images/v1 ##### [Update image](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/edit) PATCH/accounts/{account\_id}/images/v1/{image\_id} ##### [Delete image](https://developers.cloudflare.com/api/resources/images/subresources/v1/methods/delete) DELETE/accounts/{account\_id}/images/v1/{image\_id} ##### ModelsExpand Collapse

Image object {id, creator, filename, 4 more }

id: optional string Image unique identifier. maxLength32 Link to this property creator: optional string Can set the creator field with an internal user ID. maxLength1024 Link to this property filename: optional string Image file name. maxLength255 Link to this property meta: optional unknown 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. Link to this property requireSignedURLs: optional boolean 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. Link to this property uploaded: optional string When the media item was uploaded. formatdate-time Link to this property variants: optional array of string Object specifying available variants for an image. Link to this property

[Link to this property](<#(resource)%20images.v1%20%3E%20(model)%20image%20%3E%20(schema)>)

V1ListResponse object {images }

images: optional array of Image { id, creator, filename, 4 more }

Link to this property

[Link to this property](<#(resource)%20images.v1%20%3E%20(model)%20v1_list_response%20%3E%20(schema)>)

V1DeleteResponse = unknownor string

One of the following: unknown Link to this property string Link to this property

[Link to this property](<#(resource)%20images.v1%20%3E%20(model)%20v1_delete_response%20%3E%20(schema)>) #### ImagesV1Keys ##### [List Signing Keys](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/keys/methods/list) GET/accounts/{account\_id}/images/v1/keys ##### [Create a new Signing Key](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/keys/methods/update) PUT/accounts/{account\_id}/images/v1/keys/{signing\_key\_name} ##### [Delete Signing Key](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/keys/methods/delete) DELETE/accounts/{account\_id}/images/v1/keys/{signing\_key\_name} ##### ModelsExpand Collapse

Key object {name, value }

name: optional string Key name. Link to this property value: optional string Key value. Link to this property

[Link to this property](<#(resource)%20images.v1.keys%20%3E%20(model)%20key%20%3E%20(schema)>)

KeyListResponse object {keys }

keys: optional array of Key { name, value }

name: optional string Key name. Link to this property value: optional string Key value. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.keys%20%3E%20(model)%20key_list_response%20%3E%20(schema)>)

KeyUpdateResponse object {keys }

keys: optional array of Key { name, value }

name: optional string Key name. Link to this property value: optional string Key value. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.keys%20%3E%20(model)%20key_update_response%20%3E%20(schema)>)

KeyDeleteResponse object {keys }

keys: optional array of Key { name, value }

name: optional string Key name. Link to this property value: optional string Key value. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.keys%20%3E%20(model)%20key_delete_response%20%3E%20(schema)>) #### ImagesV1Stats ##### [Images usage statistics](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/stats/methods/get) GET/accounts/{account\_id}/images/v1/stats ##### ModelsExpand Collapse

Stat object {count }

count: optional object {allowed, current }

allowed: optional number Cloudflare Images allowed usage. Link to this property current: optional number Cloudflare Images current usage. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.stats%20%3E%20(model)%20stat%20%3E%20(schema)>) #### ImagesV1Variants ##### [List variants](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/variants/methods/list) GET/accounts/{account\_id}/images/v1/variants ##### [Variant details](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/variants/methods/get) GET/accounts/{account\_id}/images/v1/variants/{variant\_id} ##### [Create a variant](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/variants/methods/create) POST/accounts/{account\_id}/images/v1/variants ##### [Update a variant](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/variants/methods/edit) PATCH/accounts/{account\_id}/images/v1/variants/{variant\_id} ##### [Delete a variant](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/variants/methods/delete) DELETE/accounts/{account\_id}/images/v1/variants/{variant\_id} ##### ModelsExpand Collapse

Variant object {variants }

variants: optional object {hero }

hero: optional object {id, options, neverRequireSignedURLs }

id: string maxLength99 Link to this property

options: object {fit, height, metadata, width } Allows you to define image resizing sizes for different use cases.

fit: "scale-down"or "contain"or "cover"or 2 more The fit property describes how the width and height dimensions should be interpreted.

One of the following: "scale-down" Link to this property "contain" Link to this property "cover" Link to this property "crop" Link to this property "pad" Link to this property

Link to this property height: number Maximum height in image pixels. minimum1 Link to this property

metadata: "keep"or "copyright"or "none" What EXIF data should be preserved in the output image.

One of the following: "keep" Link to this property "copyright" Link to this property "none" Link to this property

Link to this property width: number Maximum width in image pixels. minimum1 Link to this property

Link to this property neverRequireSignedURLs: optional boolean Indicates whether the variant can access an image without a signature, regardless of image access control. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(model)%20variant%20%3E%20(schema)>)

VariantGetResponse object {variant }

variant: optional object {id, options, neverRequireSignedURLs }

id: string maxLength99 Link to this property

options: object {fit, height, metadata, width } Allows you to define image resizing sizes for different use cases.

fit: "scale-down"or "contain"or "cover"or 2 more The fit property describes how the width and height dimensions should be interpreted.

One of the following: "scale-down" Link to this property "contain" Link to this property "cover" Link to this property "crop" Link to this property "pad" Link to this property

Link to this property height: number Maximum height in image pixels. minimum1 Link to this property

metadata: "keep"or "copyright"or "none" What EXIF data should be preserved in the output image.

One of the following: "keep" Link to this property "copyright" Link to this property "none" Link to this property

Link to this property width: number Maximum width in image pixels. minimum1 Link to this property

Link to this property neverRequireSignedURLs: optional boolean Indicates whether the variant can access an image without a signature, regardless of image access control. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(model)%20variant_get_response%20%3E%20(schema)>)

VariantCreateResponse object {variant }

variant: optional object {id, options, neverRequireSignedURLs }

id: string maxLength99 Link to this property

options: object {fit, height, metadata, width } Allows you to define image resizing sizes for different use cases.

fit: "scale-down"or "contain"or "cover"or 2 more The fit property describes how the width and height dimensions should be interpreted.

One of the following: "scale-down" Link to this property "contain" Link to this property "cover" Link to this property "crop" Link to this property "pad" Link to this property

Link to this property height: number Maximum height in image pixels. minimum1 Link to this property

metadata: "keep"or "copyright"or "none" What EXIF data should be preserved in the output image.

One of the following: "keep" Link to this property "copyright" Link to this property "none" Link to this property

Link to this property width: number Maximum width in image pixels. minimum1 Link to this property

Link to this property neverRequireSignedURLs: optional boolean Indicates whether the variant can access an image without a signature, regardless of image access control. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(model)%20variant_create_response%20%3E%20(schema)>)

VariantEditResponse object {variant }

variant: optional object {id, options, neverRequireSignedURLs }

id: string maxLength99 Link to this property

options: object {fit, height, metadata, width } Allows you to define image resizing sizes for different use cases.

fit: "scale-down"or "contain"or "cover"or 2 more The fit property describes how the width and height dimensions should be interpreted.

One of the following: "scale-down" Link to this property "contain" Link to this property "cover" Link to this property "crop" Link to this property "pad" Link to this property

Link to this property height: number Maximum height in image pixels. minimum1 Link to this property

metadata: "keep"or "copyright"or "none" What EXIF data should be preserved in the output image.

One of the following: "keep" Link to this property "copyright" Link to this property "none" Link to this property

Link to this property width: number Maximum width in image pixels. minimum1 Link to this property

Link to this property neverRequireSignedURLs: optional boolean Indicates whether the variant can access an image without a signature, regardless of image access control. Link to this property

Link to this property

[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(model)%20variant_edit_response%20%3E%20(schema)>)

VariantDeleteResponse = unknownor string

One of the following: unknown Link to this property string Link to this property

[Link to this property](<#(resource)%20images.v1.variants%20%3E%20(model)%20variant_delete_response%20%3E%20(schema)>) #### ImagesV1Blobs ##### [Download image](https://developers.cloudflare.com/api/resources/images/subresources/v1/subresources/blobs/methods/get) GET/accounts/{account\_id}/images/v1/{image\_id}/blob #### ImagesV2 ##### [List images V2](https://developers.cloudflare.com/api/resources/images/subresources/v2/methods/list) GET/accounts/{account\_id}/images/v2 ##### ModelsExpand Collapse

V2ListResponse object {continuation\_token, images }

continuation\_token: optional string Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint. maxLength32 Link to this property

images: optional array of Image { id, creator, filename, 4 more }

Link to this property

[Link to this property](<#(resource)%20images.v2%20%3E%20(model)%20v2_list_response%20%3E%20(schema)>) #### ImagesV2Direct Uploads ##### [Create authenticated direct upload URL V2](https://developers.cloudflare.com/api/resources/images/subresources/v2/subresources/direct_uploads/methods/create) POST/accounts/{account\_id}/images/v2/direct\_upload ##### ModelsExpand Collapse

DirectUploadCreateResponse object {id, uploadURL }

id: optional string Image unique identifier. maxLength32 Link to this property uploadURL: optional string The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request. Link to this property

[Link to this property](<#(resource)%20images.v2.direct_uploads%20%3E%20(model)%20direct_upload_create_response%20%3E%20(schema)>)