APIs.io Engineering Platform Cloudflare Images API

openapi: 3.2.0
info:
  description: 'To get started using Cloudflare''s products and services via the API, refer to [how to interact with Cloudflare](https://developers.cloudflare.com/fundamentals/basic-tasks/interact-with-cloudflare/), which covers using tools like [Terraform](https://developers.cloudflare.com/terraform/#cloudflare-terraform) and the [official SDKs](https://developers.cloudflare.com/fundamentals/api/reference/sdks/) to maintain your Cloudflare resources.


    Using the Cloudflare API requires authentication so that Cloudflare knows who is making requests and what permissions you have. Create an API token to grant access to the API to perform actions.


    To create an API token, from the Cloudflare dashboard, go to My Profile > API Tokens and select Create Token. For more information on how to create and troubleshoot API tokens, refer to

    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).


    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).'
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  title: APIs.io Engineering Platform Cloudflare Cloudflare Images API
  version: 4.0.0
tags:
- name: Cloudflare Images
paths:
  /accounts/{account_id}/images/v1:
    get:
      deprecated: true
      description: List up to 100 images with one request. Use the optional parameters below to get a specific range of images.
      operationId: cloudflare-images-list-images
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      - in: query
        name: per_page
        schema:
          default: 1000
          description: Number of items per page.
          maximum: 10000
          minimum: 10
          type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_images_list_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List images response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_images_list_response'
          description: List images response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List images
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Read
      - Images Write
    post:
      description: 'Upload an image with up to 10 Megabytes using a single HTTP POST (multipart/form-data) request.

        An image can be uploaded by sending an image file or passing an accessible to an API url.

        '
      operationId: cloudflare-images-upload-an-image-via-url
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/images_image_basic_upload'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_response_single'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Upload an image response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_response_single'
          description: Upload an image response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Upload an image
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Write
  /accounts/{account_id}/images/v1/{image_id}:
    delete:
      description: Delete an image on Cloudflare Images. On success, all copies of the image are deleted and purged from cache.
      operationId: cloudflare-images-delete-image
      parameters:
      - in: path
        name: image_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_deleted_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Delete image response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_deleted_response'
          description: Delete image response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete image
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Write
    get:
      description: Fetch details for a single image.
      operationId: cloudflare-images-image-details
      parameters:
      - in: path
        name: image_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_response_single'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Image details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_response_single'
          description: Image details response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Image details
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Read
      - Images Write
    patch:
      description: Update image access control. On access control change, all copies of the image are purged from cache.
      operationId: cloudflare-images-update-image
      parameters:
      - in: path
        name: image_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/images_image_patch_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_response_single'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Update image response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_response_single'
          description: Update image response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update image
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Write
  /accounts/{account_id}/images/v1/{image_id}/blob:
    get:
      description: Fetch base image. For most images this will be the originally uploaded file. For larger images it can be a near-lossless version of the original.
      operationId: cloudflare-images-base-image
      parameters:
      - in: path
        name: image_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_response_blob'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Base image response failure
        '200':
          content:
            image/*:
              schema:
                format: binary
                type: string
          description: Base image response. Returns uploaded image data.
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Base image
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Read
      - Images Write
  /accounts/{account_id}/images/v1/stats:
    get:
      description: Fetch usage statistics details for Cloudflare Images.
      operationId: cloudflare-images-images-usage-statistics
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_images_stats_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Images usage statistics response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_images_stats_response'
          description: Images usage statistics response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Images usage statistics
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Read
      - Images Write
  /accounts/{account_id}/images/v2:
    get:
      description: 'List up to 10000 images with one request. Use the optional parameters below to get a specific range of images.

        Endpoint returns continuation_token if more images are present.

        '
      operationId: cloudflare-images-list-images-v2
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      - in: query
        name: continuation_token
        schema:
          description: Continuation token for a next page. List images V2 returns continuation_token
          type:
          - string
          - 'null'
      - in: query
        name: per_page
        schema:
          default: 1000
          description: Number of items per page.
          maximum: 10000
          minimum: 10
          type: number
      - in: query
        name: sort_order
        schema:
          default: desc
          description: Sorting order by upload time.
          enum:
          - asc
          - desc
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_images_list_response_v2'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List images response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_images_list_response_v2'
          description: List images response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List images V2
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Read
      - Images Write
  /accounts/{account_id}/images/v2/direct_upload:
    post:
      description: 'Direct uploads allow users to upload images without API keys. A common use case are web apps, client-side applications, or mobile devices where users upload content directly to Cloudflare Images. This method creates a draft record for a future image. It returns an upload URL and an image identifier. To verify if the image itself has been uploaded, send an image details request (accounts/:account_identifier/images/v1/:identifier), and check that the `draft: true` property is not present.'
      operationId: cloudflare-images-create-authenticated-direct-upload-url-v-2
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/images_image_direct_upload_request_v2'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_direct_upload_response_v2'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Create authenticated direct upload URL V2 response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_direct_upload_response_v2'
          description: Create authenticated direct upload URL V2 response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create authenticated direct upload URL V2
      tags:
      - Cloudflare Images
      x-api-token-group:
      - Images Write
components:
  schemas:
    images_image_direct_upload_response_v2:
      allOf:
      - $ref: '#/components/schemas/images_api-response-single'
      - properties:
          result:
            properties:
              id:
                description: Image unique identifier.
                example: e22e9e6b-c02b-42fd-c405-6c32af5fe600
                maxLength: 32
                readOnly: true
                type: string
              uploadURL:
                description: The URL the unauthenticated upload can be performed to using a single HTTP POST (multipart/form-data) request.
                example: https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600
                type: string
    images_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    images_image_requireSignedURLs:
      default: false
      description: 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.
      example: true
      type: boolean
    images_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/images_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/images_messages'
          example: []
        result:
          enum:
          - null
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    images_image_original_url:
      description: URI to original variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original
      format: uri
      readOnly: true
      type: string
    images_image_hero_url:
      description: URI to hero variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero
      format: uri
      readOnly: true
      type: string
    images_image_filename:
      description: Image file name.
      example: logo.png
      maxLength: 255
      readOnly: true
      type: string
    images_api-response-collection-v2:
      allOf:
      - $ref: '#/components/schemas/images_api-response-common'
      - properties:
          result:
            properties:
              continuation_token:
                $ref: '#/components/schemas/images_images_list_continuation_token'
            type: object
      type: object
    images_image_response_blob:
      anyOf:
      - type: string
      - type: object
      example: <image blob data>
    images_image_thumbnail_url:
      description: URI to thumbnail variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail
      format: uri
      readOnly: true
      type: string
    images_image_uploaded:
      description: When the media item was uploaded.
      example: '2014-01-02T02:20:00.123Z'
      format: date-time
      readOnly: true
      type: string
    images_account_identifier:
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    images_images_stats_current:
      description: Cloudflare Images current usage.
      example: 1000
      readOnly: true
      type: number
    images_image_direct_upload_request_v2:
      properties:
        expiry:
          default: Now + 30 minutes
          description: 'The date after which the upload will not be accepted. Minimum: Now + 2 minutes. Maximum: Now + 6 hours.'
          example: '2021-01-02T02:20:00Z'
          format: date-time
          type: string
        id:
          description: Optional Image Custom ID. Up to 1024 chars. Can include any number of subpaths, and utf8 characters. Cannot start nor end with a / (forward slash). Cannot be a UUID.
          example: this/is/my-customid
          maxLength: 1024
          type: string
        metadata:
          description: User modifiable key-value store. Can be used for keeping references to another system of record, for managing images.
          type: object
        requireSignedURLs:
          default: false
          description: Indicates whether the image requires a signature token to be accessed.
          example: true
          type: boolean
      type: object
    images_image_variants:
      description: Object specifying available variants for an image.
      example:
      - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail
      - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero
      - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original
      items:
        anyOf:
        - $ref: '#/components/schemas/images_image_thumbnail_url'
        - $ref: '#/components/schemas/images_image_hero_url'
        - $ref: '#/components/schemas/images_image_original_url'
      readOnly: true
      type: array
    images_images_stats:
      properties:
        count:
          $ref: '#/components/schemas/images_images_stats_count'
      type: object
    images_image_identifier:
      description: Image unique identifier.
      example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900
      maxLength: 32
      readOnly: true
      type: string
    images_api-response-single:
      allOf:
      - $ref: '#/components/schemas/images_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    images_image_response_single:
      allOf:
      - $ref: '#/components/schemas/images_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/images_image'
    images_images_stats_count:
      properties:
        allowed:
          $ref: '#/components/schemas/images_images_stats_allowed'
        current:
          $ref: '#/components/schemas/images_images_stats_current'
      type: object
    images_images_list_continuation_token:
      description: Continuation token to fetch next page. Passed as a query param when requesting List V2 api endpoint.
      example: iD0bxlWFSVUWsDHbzIqvDkgBW4otifAAuGXLz1n8BQA
      maxLength: 32
      readOnly: true
      type:
      - string
      - 'null'
    images_image_basic_upload:
      properties:
        file:
          description: An image binary data. Only needed when type is uploading a file.
          format: binary
        metadata:
          description: User modifiable key-value store. Can use used for keeping references to another system of record for managing images.
          type: object
        requireSignedURLs:
          default: false
          description: Indicates whether the image requires a signature token for the access.
          example: true
          type: boolean
        url:
          description: A URL to fetch an image from origin. Only needed when type is uploading from a URL.
          example: https://example.com/path/to/logo.png
          type: string
      type: object
    images_image_metadata:
      description: 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.
      example:
        key: value
      type: object
    images_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/images_messages'
        messages:
          $ref: '#/components/schemas/images_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    images_images_stats_response:
      allOf:
      - $ref: '#/components/schemas/images_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/images_images_stats'
    images_image:
      properties:
        filename:
          $ref: '#/components/schemas/images_image_filename'
        id:
          $ref: '#/components/schemas/images_image_identifier'
        meta:
          $ref: '#/components/schemas/images_image_metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/images_image_requireSignedURLs'
        uploaded:
          $ref: '#/components/schemas/images_image_uploaded'
        variants:
          $ref: '#/components/schemas/images_image_variants'
      type: object
    images_images_list_response:
      allOf:
      - $ref: '#/components/schemas/images_api-response-common'
      - properties:
          result:
            properties:
              images:
                items:
                  $ref: '#/components/schemas/images_image'
                type: array
            type: object
    images_images_list_response_v2:
      allOf:
      - $ref: '#/components/schemas/images_api-response-collection-v2'
      - properties:
          result:
            properties:
              images:
                items:
                  $ref: '#/components/schemas/images_image'
                type: array
            type: object
    images_image_patch_request:
      properties:
        metadata:
          description: User modifiable key-value store. Can be used for keeping references to another system of record for managing images. No change if not specified.
          type: object
        requireSignedURLs:
          description: Indicates whether the image can be accessed using only its UID. If set to `true`, a signed token needs to be generated with a signing key to view the image. Returns a new UID on a change. No change if not specified.
          example: true
          type: boolean
      type: object
    images_deleted_response:
      allOf:
      - $ref: '#/components/schemas/images_api-response-single'
      - properties:
          result:
            example: {}
            type: object
    images_images_stats_allowed:
      description: Cloudflare Images allowed usage.
      example: 100000
      readOnly: true
      type: number
  securitySchemes:
    api_email:
      in: header
      name: X-Auth-Email
      type: apiKey
    api_key:
      in: header
      name: X-Auth-Key
      type: apiKey
    api_token:
      scheme: bearer
      type: http
    user_service_key:
      in: header
      name: X-Auth-User-Service-Key
      type: apiKey