Update a variant

PATCH

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/images/v1/variants/{identifier}

Last modified:2022-12-16 13:48:32

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

Request

Path Params

identifier

string

required

account_identifier

string

required

Body Params application/json

neverRequireSignedURLs

boolean

optional

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

Default:

false

Example:

true

options

object (options)

required

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

fit

enum<string>

required

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

Allowed values:

scale-downcontaincovercroppad

Example:

scale-down

height

number

required

Maximum height in image pixels.

>= 1

Example:

768

metadata

enum<string>

required

What EXIF data should be preserved in the output image.

Allowed values:

keepcopyrightnone

Example:

none

width

number

required

Maximum width in image pixels.

>= 1

Example:

1366

Example

{
    "neverRequireSignedURLs": true,
    "options": {
        "fit": "scale-down",
        "height": 768,
        "metadata": "none",
        "width": 1366
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/accounts//images/v1/variants/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "neverRequireSignedURLs": true,
    "options": {
        "fit": "scale-down",
        "height": 768,
        "metadata": "none",
        "width": 1366
    }
}'

Responses

🟢200Update a variant response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (variant_response)

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "variant": {}
    },
    "success": true
}

🟢200Update a variant response failure

Modified at 2022-12-16 13:48:32

Variant details

List Cloudflare Tunnels