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

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

Servers

Path parameters

Name Type Required Description
variant_id String Yes
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
options Object Yes

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

options.height Number Yes

Maximum height in image pixels.

options.width Number Yes

Maximum width in image pixels.

options.fit String Yes

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

Possible values:

  • "pad"
  • "contain"
  • "scale-down"
  • "cover"
  • "crop"
options.metadata String Yes

What EXIF data should be preserved in the output image.

Possible values:

  • "keep"
  • "copyright"
  • "none"
neverRequireSignedURLs Boolean No

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

Default value: false

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.