Update a variant

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

Copy endpoint

https://api.cloudflare.com/client/v4

Updating a variant purges the cache for all images associated with the variant.

Parameters

path Path Parameters

Name	Type
`variant_id` required	type ImagesImageVariantIdentifier = string
`account_id` required	type ImagesAccountIdentifier = string

Request Body

application/json required

interface ImagesImageVariantPatchRequest {
neverRequireSignedURLs?:

ImagesImageVariantNeverRequireSignedURLs

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

type ImagesImageVariantNeverRequireSignedURLs = boolean

;
options:

ImagesImageVariantOptions

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

interface ImagesImageVariantOptions {
fit: ImagesImageVariantFit;
height: ImagesImageVariantHeight;
metadata: ImagesImageVariantSchemasMetadata;
width: ImagesImageVariantWidth;
}

;
}

Responses

200 application/json

Update a variant response

type ImagesImageVariantSimpleResponse = type ImagesApiResponseSingle = never & { result?:

ImagesImageVariantResponse

interface ImagesImageVariantResponse {
variant?: ImagesImageVariantDefinition;
}

; }

Client Errors

4XX application/json

Update a variant response failure

type ImagesImageVariantSimpleResponse = type ImagesApiResponseSingle = never & { result?:

ImagesImageVariantResponse

interface ImagesImageVariantResponse {
variant?: ImagesImageVariantDefinition;
}

; } & interface ImagesApiResponseCommonFailure {
errors:

ImagesMessages

type ImagesMessages = { code: number;message: string; }[]

;
messages:

ImagesMessages

type ImagesMessages = { code: number;message: string; }[]

;
result: null;
success: false;
}