APIs.io Engineering Platform Cloudflare Images API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 9 operations across 6 paths, and defines 31 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.

9 operations 6 paths 31 schemas 1 DELETE5 GET1 PATCH2 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

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform Cloudflare Images 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 9

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

Cloudflare Images 9

GET

/accounts/{account_id}/images/v1deprecated

APIs.io Engineering Platform List images

cloudflare-images-list-images 3 params → 4XX200

POST

/accounts/{account_id}/images/v1

APIs.io Engineering Platform Upload an image

cloudflare-images-upload-an-image-via-url 1 param body → 4XX200

DELETE

/accounts/{account_id}/images/v1/{image_id}

APIs.io Engineering Platform Delete image

cloudflare-images-delete-image 2 params body → 4XX200

GET

/accounts/{account_id}/images/v1/{image_id}

APIs.io Engineering Platform Image details

cloudflare-images-image-details 2 params → 4XX200

PATCH

/accounts/{account_id}/images/v1/{image_id}

APIs.io Engineering Platform Update image

cloudflare-images-update-image 2 params body → 4XX200

GET

/accounts/{account_id}/images/v1/{image_id}/blob

APIs.io Engineering Platform Base image

cloudflare-images-base-image 2 params → 4XX200

GET

/accounts/{account_id}/images/v1/stats

APIs.io Engineering Platform Images usage statistics

cloudflare-images-images-usage-statistics 1 param → 4XX200

GET

/accounts/{account_id}/images/v2

APIs.io Engineering Platform List images V2

cloudflare-images-list-images-v2 4 params → 4XX200

POST

/accounts/{account_id}/images/v2/direct_upload

APIs.io Engineering Platform Create authenticated direct upload URL V2

cloudflare-images-create-authenticated-direct-upload-url-v-2 1 param body → 4XX200

Schemas 31

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

images_image_response_blob

images_api-response-single

object

images_image_basic_upload

object

4 properties

images_image_direct_upload_request_v2

object

4 properties

images_images_stats

object

1 property

images_image_uploaded

string

When the media item was uploaded.

images_images_list_response

images_deleted_response

images_api-response-common

object

4 properties 4 required

images_images_list_continuation_token

string

Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.

images_image_hero_url

string

URI to hero variant for an image.

images_image_response_single

images_api-response-common-failure

object

4 properties 4 required

images_image_variants

array

Object specifying available variants for an image.

images_image_requireSignedURLs

boolean

Indicates whether the image can be a accessed only using it's UID. If set to true, a signed token needs to be generated with a signing key to view the image.

images_images_stats_current

number

Cloudflare Images current usage.

images_image_filename

string

Image file name.

images_image_direct_upload_response_v2

images_images_stats_allowed

number

Cloudflare Images allowed usage.

images_image

object

6 properties

images_images_stats_count

object

2 properties

images_image_metadata

object

User modifiable key-value store. Can be used for keeping references to another system of record for managing images. Metadata must not exceed 1024 bytes.

images_image_original_url

string

URI to original variant for an image.

images_api-response-collection-v2

object

images_images_list_response_v2

images_images_stats_response

images_image_patch_request

object

2 properties

images_image_identifier

string

Image unique identifier.

images_image_thumbnail_url

string

URI to thumbnail variant for an image.

images_account_identifier

string

Account identifier tag.

images_messages

array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#Cloudflare Images

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform Cloudflare Images API

Metadata

Authentication & Security 1

Paths & Operations 9

Schemas 31

Specification

Source

API Details

Provider

Explore more