Images

ImagesV1

List images

Deprecated

client.images.v1.list(, ?): V4PagePagination<V1ListResponse { images } >

GET/accounts/{account_id}/images/v1

Image details

client.images.v1.get(, , ?): Image { id, creator, filename, 4 more }

GET/accounts/{account_id}/images/v1/{image_id}

Upload an image

client.images.v1.create(, ?): Image { id, creator, filename, 4 more }

POST/accounts/{account_id}/images/v1

Update image

client.images.v1.edit(, , ?): Image { id, creator, filename, 4 more }

PATCH/accounts/{account_id}/images/v1/{image_id}

Delete image

client.images.v1.delete(, , ?): V1DeleteResponse

DELETE/accounts/{account_id}/images/v1/{image_id}

ModelsExpand Collapse

Image { id, creator, filename, 4 more }

id?: string

Image unique identifier.

maxLength32

creator?: string | null

Can set the creator field with an internal user ID.

maxLength1024

filename?: string

Image file name.

maxLength255

meta?: 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.

requireSignedURLs?: 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.

uploaded?: string

When the media item was uploaded.

formatdate-time

variants?: Array<string>

Object specifying available variants for an image.

V1ListResponse { images }

images?: Array<Image { id, creator, filename, 4 more } >

id?: string

Image unique identifier.

maxLength32

creator?: string | null

Can set the creator field with an internal user ID.

maxLength1024

filename?: string

Image file name.

maxLength255

meta?: 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.

requireSignedURLs?: 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.

uploaded?: string

When the media item was uploaded.

formatdate-time

variants?: Array<string>

Object specifying available variants for an image.

V1DeleteResponse = unknown | string

One of the following:

unknown

string

ImagesV1Keys

List Signing Keys

client.images.v1.keys.list(, ?): KeyListResponse { keys }

GET/accounts/{account_id}/images/v1/keys

Create a new Signing Key

client.images.v1.keys.update(, , ?): KeyUpdateResponse { keys }

PUT/accounts/{account_id}/images/v1/keys/{signing_key_name}

Delete Signing Key

client.images.v1.keys.delete(, , ?): KeyDeleteResponse { keys }

DELETE/accounts/{account_id}/images/v1/keys/{signing_key_name}

ModelsExpand Collapse

Key { name, value }

name?: string

Key name.

value?: string

Key value.

KeyListResponse { keys }

keys?: Array<Key { name, value } >

name?: string

Key name.

value?: string

Key value.

KeyUpdateResponse { keys }

keys?: Array<Key { name, value } >

name?: string

Key name.

value?: string

Key value.

KeyDeleteResponse { keys }

keys?: Array<Key { name, value } >

name?: string

Key name.

value?: string

Key value.

ImagesV1Stats

Images usage statistics

client.images.v1.stats.get(, ?): Stat { count }

GET/accounts/{account_id}/images/v1/stats

ModelsExpand Collapse

Stat { count }

count?: Count { allowed, current }

allowed?: number

Cloudflare Images allowed usage.

current?: number

Cloudflare Images current usage.

ImagesV1Variants

List variants

client.images.v1.variants.list(, ?): Variant { variants }

GET/accounts/{account_id}/images/v1/variants

Variant details

client.images.v1.variants.get(, , ?): VariantGetResponse { variant }

GET/accounts/{account_id}/images/v1/variants/{variant_id}

Create a variant

client.images.v1.variants.create(, ?): VariantCreateResponse { variant }

POST/accounts/{account_id}/images/v1/variants

Update a variant

client.images.v1.variants.edit(, , ?): VariantEditResponse { variant }

PATCH/accounts/{account_id}/images/v1/variants/{variant_id}

Delete a variant

client.images.v1.variants.delete(, , ?): VariantDeleteResponse

DELETE/accounts/{account_id}/images/v1/variants/{variant_id}

ModelsExpand Collapse

Variant { variants }

variants?: Variants { hero }

hero?: Hero { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: Options { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" | "contain" | "cover" | 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" | "copyright" | "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs?: boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantGetResponse { variant }

variant?: Variant { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: Options { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" | "contain" | "cover" | 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" | "copyright" | "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs?: boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantCreateResponse { variant }

variant?: Variant { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: Options { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" | "contain" | "cover" | 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" | "copyright" | "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs?: boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantEditResponse { variant }

variant?: Variant { id, options, neverRequireSignedURLs }

id: string

maxLength99

options: Options { fit, height, metadata, width }

Allows you to define image resizing sizes for different use cases.

fit: "scale-down" | "contain" | "cover" | 2 more

The fit property describes how the width and height dimensions should be interpreted.

One of the following:

"scale-down"

"contain"

"cover"

"crop"

"pad"

height: number

Maximum height in image pixels.

minimum1

metadata: "keep" | "copyright" | "none"

What EXIF data should be preserved in the output image.

One of the following:

"keep"

"copyright"

"none"

width: number

Maximum width in image pixels.

minimum1

neverRequireSignedURLs?: boolean

Indicates whether the variant can access an image without a signature, regardless of image access control.

VariantDeleteResponse = unknown | string

One of the following:

unknown

string

ImagesV1Blobs

Base image

client.images.v1.blobs.get(, , ?): Response

GET/accounts/{account_id}/images/v1/{image_id}/blob

ImagesV2

List images V2

client.images.v2.list(, ?): V2ListResponse { continuation_token, images }

GET/accounts/{account_id}/images/v2

ModelsExpand Collapse

V2ListResponse { continuation_token, images }

continuation_token?: string | null

Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.

maxLength32

images?: Array<Image { id, creator, filename, 4 more } >

id?: string

Image unique identifier.

maxLength32

creator?: string | null

Can set the creator field with an internal user ID.

maxLength1024

filename?: string

Image file name.

maxLength255

meta?: 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.

requireSignedURLs?: 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.

uploaded?: string

When the media item was uploaded.

formatdate-time

variants?: Array<string>

Object specifying available variants for an image.

ImagesV2Direct Uploads

Create authenticated direct upload URL V2

client.images.v2.directUploads.create(, ?): DirectUploadCreateResponse { id, uploadURL }

POST/accounts/{account_id}/images/v2/direct_upload

ModelsExpand Collapse

DirectUploadCreateResponse { id, uploadURL }

id?: string

Image unique identifier.

maxLength32

uploadURL?: string

The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.