Cloudflare Images API

openapi: 3.0.3
info:
  title: Cloudflare / Accounts Images API
  description: Needs description.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  version: 4.0.0
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Images
  description: Upload, list, update, and delete image assets.
paths:
  /accounts/{account_id}/images/v1:
    get:
      operationId: listImages
      summary: Cloudflare List Images
      description: Returns a paginated list of all images in the account.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - name: page
        in: query
        description: Page number for pagination.
        schema:
          type: integer
        example: 10
      - name: per_page
        in: query
        description: Number of images per page.
        schema:
          type: integer
        example: 10
      responses:
        '200':
          description: List of images.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageListResponse'
              examples:
                Listimages200Example:
                  summary: Default listImages 200 response
                  x-microcks-default: true
                  value:
                    result:
                      images:
                      - {}
                    success: true
        '401':
          description: Unauthorized.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: uploadImage
      summary: Cloudflare Upload Image
      description: Upload an image via file upload or URL. Supports JPEG, PNG, GIF, WebP, and SVG formats.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/AccountId'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: The image file to upload.
                url:
                  type: string
                  format: uri
                  description: URL of an image to fetch and store.
                id:
                  type: string
                  description: Custom identifier for the image.
                metadata:
                  type: object
                  description: User-defined metadata.
                requireSignedURLs:
                  type: boolean
                  description: Whether signed URLs are required.
            examples:
              UploadimageRequestExample:
                summary: Default uploadImage request
                x-microcks-default: true
                value:
                  file: example_value
                  url: https://www.example.com
                  id: abc123
                  metadata: example_value
                  requireSignedURLs: https://www.example.com
      responses:
        '200':
          description: Image uploaded successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageResponse'
              examples:
                Uploadimage200Example:
                  summary: Default uploadImage 200 response
                  x-microcks-default: true
                  value:
                    result:
                      id: abc123
                      filename: example_value
                      metadata: example_value
                      uploaded: '2026-01-15T10:30:00Z'
                      requireSignedURLs: https://www.example.com
                      variants:
                      - {}
                    success: true
                    errors:
                    - {}
                    messages:
                    - {}
        '400':
          description: Bad request.
        '401':
          description: Unauthorized.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /accounts/{account_id}/images/v1/{image_id}:
    get:
      operationId: getImage
      summary: Cloudflare Get Image Details
      description: Retrieve details of a specific image.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ImageId'
      responses:
        '200':
          description: Image details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageResponse'
              examples:
                Getimage200Example:
                  summary: Default getImage 200 response
                  x-microcks-default: true
                  value:
                    result:
                      id: abc123
                      filename: example_value
                      metadata: example_value
                      uploaded: '2026-01-15T10:30:00Z'
                      requireSignedURLs: https://www.example.com
                      variants:
                      - {}
                    success: true
                    errors:
                    - {}
                    messages:
                    - {}
        '401':
          description: Unauthorized.
        '404':
          description: Image not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    patch:
      operationId: updateImage
      summary: Cloudflare Update Image
      description: Update image metadata and settings.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ImageId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                requireSignedURLs:
                  type: boolean
            examples:
              UpdateimageRequestExample:
                summary: Default updateImage request
                x-microcks-default: true
                value:
                  metadata: example_value
                  requireSignedURLs: https://www.example.com
      responses:
        '200':
          description: Image updated.
        '401':
          description: Unauthorized.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteImage
      summary: Cloudflare Delete Image
      description: Delete an image and all its variants.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/ImageId'
      responses:
        '200':
          description: Image deleted.
        '401':
          description: Unauthorized.
        '404':
          description: Image not found.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  parameters:
    AccountId:
      name: account_id
      in: path
      required: true
      description: The unique identifier of the Cloudflare account.
      schema:
        type: string
    ImageId:
      name: image_id
      in: path
      required: true
      description: The unique identifier of the image.
      schema:
        type: string
  schemas:
    Image:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the image.
          example: abc123
        filename:
          type: string
          description: Original filename.
          example: example_value
        metadata:
          type: object
          description: User-defined metadata.
          example: example_value
        uploaded:
          type: string
          format: date-time
          description: Upload timestamp.
          example: '2026-01-15T10:30:00Z'
        requireSignedURLs:
          type: boolean
          example: https://www.example.com
        variants:
          type: array
          items:
            type: string
            format: uri
          description: URLs for each variant of the image.
          example: []
    ImageResponse:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/Image'
        success:
          type: boolean
          example: true
        errors:
          type: array
          items:
            type: object
          example: []
        messages:
          type: array
          items:
            type: object
          example: []
    ImageListResponse:
      type: object
      properties:
        result:
          type: object
          properties:
            images:
              type: array
              items:
                $ref: '#/components/schemas/Image'
          example: example_value
        success:
          type: boolean
          example: true