Change variants setting

Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the 'Vary: Accept' response header. If the origin server sends 'Vary: Accept' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.

Request

Path Params

zone_identifier

string

required

Body Params application/json

value

object (variants_value)

required

Value of the zone setting.

avif

array

optional

List of strings with the MIME types of all the variants that should be served for avif.

Example:

["image/webp","image/jpeg"]

bmp

array

optional

List of strings with the MIME types of all the variants that should be served for bmp.

Example:

["image/webp","image/jpeg"]

gif

array

optional

List of strings with the MIME types of all the variants that should be served for gif.

Example:

["image/webp","image/jpeg"]

jp2

array

optional

List of strings with the MIME types of all the variants that should be served for jp2.

Example:

["image/webp","image/avif"]

jpeg

array

optional

List of strings with the MIME types of all the variants that should be served for jpeg.

Example:

["image/webp","image/avif"]

jpg

array

optional

List of strings with the MIME types of all the variants that should be served for jpg.

Example:

["image/webp","image/avif"]

jpg2

array

optional

List of strings with the MIME types of all the variants that should be served for jpg2.

Example:

["image/webp","image/avif"]

png

array

optional

List of strings with the MIME types of all the variants that should be served for png.

Example:

["image/webp","image/avif"]

tif

array

optional

List of strings with the MIME types of all the variants that should be served for tif.

Example:

["image/webp","image/avif"]

tiff

array

optional

List of strings with the MIME types of all the variants that should be served for tiff.

Example:

["image/webp","image/avif"]

webp

array

optional

List of strings with the MIME types of all the variants that should be served for webp.

Example:

["image/jpeg","image/avif"]

Example

{
    "value": {
        "avif": [
            "image/webp",
            "image/jpeg"
        ],
        "bmp": [
            "image/webp",
            "image/jpeg"
        ],
        "gif": [
            "image/webp",
            "image/jpeg"
        ],
        "jp2": [
            "image/webp",
            "image/avif"
        ],
        "jpeg": [
            "image/webp",
            "image/avif"
        ],
        "jpg": [
            "image/webp",
            "image/avif"
        ],
        "jpg2": [
            "image/webp",
            "image/avif"
        ],
        "png": [
            "image/webp",
            "image/avif"
        ],
        "tif": [
            "image/webp",
            "image/avif"
        ],
        "tiff": [
            "image/webp",
            "image/avif"
        ],
        "webp": [
            "image/jpeg",
            "image/avif"
        ]
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Change variants setting response

application/json

Body

allOf {2}

optional

allOf {2}

optional

object (api-response-single)

optional

object

optional

object (variants_response_value)

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {
        "id": "variants",
        "modified_on": "2014-01-01T05:20:00.12345Z",
        "value": {
            "avif": [
                "image/webp",
                "image/jpeg"
            ],
            "bmp": [
                "image/webp",
                "image/jpeg"
            ],
            "gif": [
                "image/webp",
                "image/jpeg"
            ],
            "jp2": [
                "image/webp",
                "image/avif"
            ],
            "jpeg": [
                "image/webp",
                "image/avif"
            ],
            "jpg": [
                "image/webp",
                "image/avif"
            ],
            "jpg2": [
                "image/webp",
                "image/avif"
            ],
            "png": [
                "image/webp",
                "image/avif"
            ],
            "tif": [
                "image/webp",
                "image/avif"
            ],
            "tiff": [
                "image/webp",
                "image/avif"
            ],
            "webp": [
                "image/jpeg",
                "image/avif"
            ]
        }
    },
    "success": true
}

🟢200Change variants setting response failure