APIs.io Engineering Platform Cloudflare Images Variants 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 Variants API
  version: 4.0.0
tags:
- name: Cloudflare Images Variants
paths:
  /accounts/{account_id}/images/v1/variants:
    get:
      description: Lists existing variants.
      operationId: cloudflare-images-variants-list-variants
      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_image_variant_list_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List variants response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_list_response'
          description: List variants response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List variants
      tags:
      - Cloudflare Images Variants
      x-api-token-group:
      - Images Read
      - Images Write
    post:
      description: Specify variants that allow you to resize images for different use cases.
      operationId: cloudflare-images-variants-create-a-variant
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/images_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/images_image_variant_definition'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_variant_simple_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Create a variant response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_simple_response'
          description: Create a variant response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a variant
      tags:
      - Cloudflare Images Variants
      x-api-token-group:
      - Images Write
  /accounts/{account_id}/images/v1/variants/{variant_id}:
    delete:
      description: Deleting a variant purges the cache for all images associated with the variant.
      operationId: cloudflare-images-variants-delete-a-variant
      parameters:
      - in: path
        name: variant_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_variant_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 a variant response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_deleted_response'
          description: Delete a variant response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete a variant
      tags:
      - Cloudflare Images Variants
      x-api-token-group:
      - Images Write
    get:
      description: Fetch details for a single variant.
      operationId: cloudflare-images-variants-variant-details
      parameters:
      - in: path
        name: variant_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_variant_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_variant_simple_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Variant details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_simple_response'
          description: Variant details response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Variant details
      tags:
      - Cloudflare Images Variants
      x-api-token-group:
      - Images Read
      - Images Write
    patch:
      description: Updating a variant purges the cache for all images associated with the variant.
      operationId: cloudflare-images-variants-update-a-variant
      parameters:
      - in: path
        name: variant_id
        required: true
        schema:
          $ref: '#/components/schemas/images_image_variant_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_variant_patch_request'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_image_variant_simple_response'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Update a variant response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_variant_simple_response'
          description: Update a variant response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update a variant
      tags:
      - Cloudflare Images Variants
      x-api-token-group:
      - Images Write
components:
  schemas:
    images_image_variant_public_request:
      properties:
        hero:
          properties:
            id:
              $ref: '#/components/schemas/images_image_variant_identifier'
            neverRequireSignedURLs:
              $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
            options:
              $ref: '#/components/schemas/images_image_variant_options'
          required:
          - id
          - options
          type: object
      type: object
    images_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    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_variant_fit:
      description: The fit property describes how the width and height dimensions should be interpreted.
      enum:
      - scale-down
      - contain
      - cover
      - crop
      - pad
      example: scale-down
      type: string
    images_image_variant_width:
      description: Maximum width in image pixels.
      example: 1366
      minimum: 1
      type: number
    images_image_variant_schemas_metadata:
      description: What EXIF data should be preserved in the output image.
      enum:
      - keep
      - copyright
      - none
      example: none
      type: string
    images_image_variant_definition:
      properties:
        id:
          $ref: '#/components/schemas/images_image_variant_identifier'
        neverRequireSignedURLs:
          $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
        options:
          $ref: '#/components/schemas/images_image_variant_options'
      required:
      - id
      - options
      type: object
    images_image_variant_identifier:
      example: hero
      maxLength: 99
      pattern: ^[a-zA-Z0-9]$
      type: string
    images_account_identifier:
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    images_image_variant_response:
      properties:
        variant:
          $ref: '#/components/schemas/images_image_variant_definition'
      type: object
    images_image_variants_response:
      properties:
        variants:
          $ref: '#/components/schemas/images_image_variant_public_request'
      type: object
    images_api-response-single:
      allOf:
      - $ref: '#/components/schemas/images_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    images_image_variant_list_response:
      allOf:
      - $ref: '#/components/schemas/images_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/images_image_variants_response'
    images_image_variant_height:
      description: Maximum height in image pixels.
      example: 768
      minimum: 1
      type: number
    images_image_variant_patch_request:
      properties:
        neverRequireSignedURLs:
          $ref: '#/components/schemas/images_image_variant_neverRequireSignedURLs'
        options:
          $ref: '#/components/schemas/images_image_variant_options'
      required:
      - options
      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_image_variant_neverRequireSignedURLs:
      default: false
      description: Indicates whether the variant can access an image without a signature, regardless of image access control.
      example: true
      type: boolean
    images_image_variant_options:
      description: Allows you to define image resizing sizes for different use cases.
      properties:
        fit:
          $ref: '#/components/schemas/images_image_variant_fit'
        height:
          $ref: '#/components/schemas/images_image_variant_height'
        metadata:
          $ref: '#/components/schemas/images_image_variant_schemas_metadata'
        width:
          $ref: '#/components/schemas/images_image_variant_width'
      required:
      - fit
      - metadata
      - width
      - height
      type: object
    images_deleted_response:
      allOf:
      - $ref: '#/components/schemas/images_api-response-single'
      - properties:
          result:
            example: {}
            type: object
    images_image_variant_simple_response:
      allOf:
      - $ref: '#/components/schemas/images_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/images_image_variant_response'
  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