Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Cloudflare Images Variants API

The Cloudflare Images Variants API from APIs.io Engineering Platform — 2 operation(s) for cloudflare images variants.

This API exposes 5 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 2 paths 20 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Cloudflare Images Variants API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Cloudflare Images Variants 5
GET
/accounts/{account_id}/images/v1/variants
APIs.io Engineering Platform List variants
cloudflare-images-variants-list-variants 1 param → 4XX200
POST
/accounts/{account_id}/images/v1/variants
APIs.io Engineering Platform Create a variant
cloudflare-images-variants-create-a-variant 1 param body → 4XX200
DELETE
/accounts/{account_id}/images/v1/variants/{variant_id}
APIs.io Engineering Platform Delete a variant
cloudflare-images-variants-delete-a-variant 2 params body → 4XX200
GET
/accounts/{account_id}/images/v1/variants/{variant_id}
APIs.io Engineering Platform Variant details
cloudflare-images-variants-variant-details 2 params → 4XX200
PATCH
/accounts/{account_id}/images/v1/variants/{variant_id}
APIs.io Engineering Platform Update a variant
cloudflare-images-variants-update-a-variant 2 params body → 4XX200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are images_api-response-common (4 properties), images_image_variant_options (4 properties), images_api-response-common-failure (4 properties), images_image_variant_definition (3 properties). Each schema is shown below with its type and property counts.

images_api-response-single
object
images_image_variant_width
number
Maximum width in image pixels.
images_deleted_response
images_api-response-common
object
4 properties 4 required
images_image_variant_height
number
Maximum height in image pixels.
images_image_variant_patch_request
object
2 properties 1 required
images_image_variant_list_response
images_api-response-common-failure
object
4 properties 4 required
images_image_variant_neverRequireSignedURLs
boolean
Indicates whether the variant can access an image without a signature, regardless of image access control.
images_image_variant_simple_response
images_image_variant_public_request
object
1 property
images_image_variant_options
object
Allows you to define image resizing sizes for different use cases.
4 properties 4 required
images_image_variants_response
object
1 property
images_image_variant_response
object
1 property
images_image_variant_definition
object
3 properties 2 required
images_image_variant_schemas_metadata
string
What EXIF data should be preserved in the output image.
images_image_variant_fit
string
The fit property describes how the width and height dimensions should be interpreted.
images_image_variant_identifier
string
images_account_identifier
string
Account identifier tag.
images_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-cloudflare-images-variants-api-openapi.yml Raw ↑