APIs.io Engineering Platform Cloudflare Images Keys API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Cloudflare Images Keys API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Cloudflare Images Keys
paths:
  /accounts/{account_id}/images/v1/keys:
    get:
      description: Lists your signing keys. These can be found on your Cloudflare Images dashboard.
      operationId: cloudflare-images-keys-list-signing-keys
      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_key_response_collection'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: List Signing Keys response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_key_response_collection'
          description: List Signing Keys response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Signing Keys
      tags:
      - Cloudflare Images Keys
      x-api-token-group:
      - Images Read
      - Images Write
  /accounts/{account_id}/images/v1/keys/{signing_key_name}:
    delete:
      description: 'Delete signing key with specified name. Returns all keys available.

        When last key is removed, a new default signing key will be generated.

        '
      operationId: cloudflare-images-keys-delete-signing-key
      parameters:
      - in: path
        name: signing_key_name
        required: true
        schema:
          $ref: '#/components/schemas/images_signing_key_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_key_response_collection'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Delete Signing Key response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_key_response_collection'
          description: Delete Signing Key response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Signing Key
      tags:
      - Cloudflare Images Keys
    put:
      description: Create a new signing key with specified name. Returns all keys available.
      operationId: cloudflare-images-keys-add-signing-key
      parameters:
      - in: path
        name: signing_key_name
        required: true
        schema:
          $ref: '#/components/schemas/images_signing_key_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_key_response_collection'
                - $ref: '#/components/schemas/images_api-response-common-failure'
          description: Add Signing Key response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_image_key_response_collection'
          description: Add Signing Key response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create a new Signing Key
      tags:
      - Cloudflare Images Keys
components:
  schemas:
    images_image_key_name:
      description: Key name.
      example: default
      readOnly: true
      type: string
    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
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    images_image_key_response_collection:
      allOf:
      - $ref: '#/components/schemas/images_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/images_image_keys_response'
    images_image_keys:
      properties:
        name:
          $ref: '#/components/schemas/images_image_key_name'
        value:
          $ref: '#/components/schemas/images_image_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_image_key_value:
      description: Key value.
      example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=
      readOnly: true
      type: string
    images_account_identifier:
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    images_signing_key_identifier:
      example: someKey
      maxLength: 20
      pattern: ^[a-zA-Z0-9]$
      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_keys_response:
      properties:
        keys:
          items:
            $ref: '#/components/schemas/images_image_keys'
          type: array
      type: object
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true