Skip to content
Cloudflare API
Start here
API Reference
Images
V1

Variants

List variants
images.v1.variants.list(VariantListParams**kwargs) -> Variant
GET/accounts/{account_id}/images/v1/variants
Variant details
images.v1.variants.get(strvariant_id, VariantGetParams**kwargs) -> VariantGetResponse
GET/accounts/{account_id}/images/v1/variants/{variant_id}
Create a variant
images.v1.variants.create(VariantCreateParams**kwargs) -> VariantCreateResponse
POST/accounts/{account_id}/images/v1/variants
Update a variant
images.v1.variants.edit(strvariant_id, VariantEditParams**kwargs) -> VariantEditResponse
PATCH/accounts/{account_id}/images/v1/variants/{variant_id}
Delete a variant
images.v1.variants.delete(strvariant_id, VariantDeleteParams**kwargs) -> VariantDeleteResponse
DELETE/accounts/{account_id}/images/v1/variants/{variant_id}
ModelsExpand Collapse
class Variant: …
variants: Optional[Variants]
hero: Optional[VariantsHero]
id: str
maxLength99
options: VariantsHeroOptions

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

fit: Literal["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: float

Maximum height in image pixels.

minimum1
metadata: Literal["keep", "copyright", "none"]

What EXIF data should be preserved in the output image.

One of the following:
"keep"
"copyright"
"none"
width: float

Maximum width in image pixels.

minimum1
never_require_signed_urls: Optional[bool]

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

class VariantGetResponse: …
variant: Optional[Variant]
id: str
maxLength99
options: VariantOptions

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

fit: Literal["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: float

Maximum height in image pixels.

minimum1
metadata: Literal["keep", "copyright", "none"]

What EXIF data should be preserved in the output image.

One of the following:
"keep"
"copyright"
"none"
width: float

Maximum width in image pixels.

minimum1
never_require_signed_urls: Optional[bool]

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

class VariantCreateResponse: …
variant: Optional[Variant]
id: str
maxLength99
options: VariantOptions

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

fit: Literal["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: float

Maximum height in image pixels.

minimum1
metadata: Literal["keep", "copyright", "none"]

What EXIF data should be preserved in the output image.

One of the following:
"keep"
"copyright"
"none"
width: float

Maximum width in image pixels.

minimum1
never_require_signed_urls: Optional[bool]

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

class VariantEditResponse: …
variant: Optional[Variant]
id: str
maxLength99
options: VariantOptions

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

fit: Literal["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: float

Maximum height in image pixels.

minimum1
metadata: Literal["keep", "copyright", "none"]

What EXIF data should be preserved in the output image.

One of the following:
"keep"
"copyright"
"none"
width: float

Maximum width in image pixels.

minimum1
never_require_signed_urls: Optional[bool]

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

Union[str, object]
One of the following:
str
object