APIs.io Engineering Platform Access Key Configuration 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 Access Key Configuration API
  version: 4.0.0
tags:
- name: Access Key Configuration
paths:
  /accounts/{account_id}/access/keys:
    get:
      description: Gets the Access key rotation settings for an account.
      operationId: access-key-configuration-get-the-access-key-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Get the Access key configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_keys_components-schemas-single_response'
          description: Get the Access key configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get the Access key configuration
      tags:
      - Access Key Configuration
      x-api-token-group:
      - 'Access: Organizations, Identity Providers, and Groups Write'
      - 'Access: Organizations, Identity Providers, and Groups Read'
    put:
      description: Updates the Access key rotation settings for an account.
      operationId: access-key-configuration-update-the-access-key-configuration
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                key_rotation_interval_days:
                  $ref: '#/components/schemas/access_key_rotation_interval_days'
              required:
              - key_rotation_interval_days
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update the Access key configuration response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_keys_components-schemas-single_response'
          description: Update the Access key configuration response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update the Access key configuration
      tags:
      - Access Key Configuration
      x-api-token-group:
      - 'Access: Organizations, Identity Providers, and Groups Write'
  /accounts/{account_id}/access/keys/rotate:
    post:
      description: Perfoms a key rotation for an account.
      operationId: access-key-configuration-rotate-access-keys
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Rotate Access keys response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_keys_components-schemas-single_response'
          description: Rotate Access keys response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Rotate Access keys
      tags:
      - Access Key Configuration
      x-api-token-group:
      - 'Access: Organizations, Identity Providers, and Groups Write'
components:
  schemas:
    access_key_rotation_interval_days:
      description: The number of days between key rotations.
      example: 30
      maximum: 365
      minimum: 21
      type: number
    access_api-response-single:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      type: object
    access_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    access_key_config:
      properties:
        days_until_next_rotation:
          $ref: '#/components/schemas/access_days_until_next_rotation'
        key_rotation_interval_days:
          $ref: '#/components/schemas/access_key_rotation_interval_days'
        last_key_rotation_at:
          $ref: '#/components/schemas/access_last_key_rotation_at'
      type: object
    access_days_until_next_rotation:
      description: The number of days until the next key rotation.
      example: 1
      readOnly: true
      type: number
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    access_keys_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_key_config'
    access_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/access_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
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    access_last_key_rotation_at:
      description: The timestamp of the previous key rotation.
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
  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