APIs.io Engineering Platform Access mTLS Authentication 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 mTLS Authentication API
  version: 4.0.0
tags:
- name: Access mTLS Authentication
paths:
  /accounts/{account_id}/access/certificates:
    get:
      description: Lists all mTLS root certificates.
      operationId: access-mtls-authentication-list-mtls-certificates
      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: List mTLS certificates response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-response_collection'
          description: List mTLS certificates response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List mTLS certificates
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
      - 'Access: Certificates Read'
    post:
      description: Adds a new mTLS root certificate to Access.
      operationId: access-mtls-authentication-add-an-mtls-certificate
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                certificate:
                  description: The certificate content.
                  example: '-----BEGIN CERTIFICATE-----

                    MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10

                    DrUtmu/B

                    -----END CERTIFICATE-----'
                  type: string
                name:
                  $ref: '#/components/schemas/access_certificates_components-schemas-name'
              required:
              - name
              - certificate
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Add an mTLS certificate response failure
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
          description: Add an mTLS certificate response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add an mTLS certificate
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
  /accounts/{account_id}/access/certificates/{certificate_id}:
    delete:
      description: Deletes an mTLS certificate.
      operationId: access-mtls-authentication-delete-an-mtls-certificate
      parameters:
      - in: path
        name: certificate_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - 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: Delete an mTLS certificate response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-id_response'
          description: Delete an mTLS certificate response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an mTLS certificate
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
    get:
      description: Fetches a single mTLS certificate.
      operationId: access-mtls-authentication-get-an-mtls-certificate
      parameters:
      - in: path
        name: certificate_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - 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 an mTLS certificate response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
          description: Get an mTLS certificate response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an mTLS certificate
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
      - 'Access: Certificates Read'
    put:
      description: Updates a configured mTLS certificate.
      operationId: access-mtls-authentication-update-an-mtls-certificate
      parameters:
      - in: path
        name: certificate_id
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                name:
                  $ref: '#/components/schemas/access_certificates_components-schemas-name'
              required:
              - associated_hostnames
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an mTLS certificate response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
          description: Update an mTLS certificate response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an mTLS certificate
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
  /accounts/{account_id}/access/certificates/settings:
    get:
      description: List all mTLS hostname settings for this account.
      operationId: access-mtls-authentication-list-mtls-certificates-hostname-settings
      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: List mTLS hostname settings response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection_hostnames'
          description: List mTLS hostname settings response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List all mTLS hostname settings
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
      - 'Access: Certificates Read'
    put:
      description: Updates an mTLS certificate's hostname settings.
      operationId: access-mtls-authentication-update-an-mtls-certificate-settings
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                settings:
                  items:
                    $ref: '#/components/schemas/access_settings'
                  type: array
              required:
              - settings
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
          description: Update an mTLS certificates hostname settings failure
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection_hostnames'
          description: Update an mTLS certificates hostname settings response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an mTLS certificate's hostname settings
      tags:
      - Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
components:
  schemas:
    access_result_info:
      properties:
        count:
          description: Total number of results for the requested service
          example: 1
          type: number
        page:
          description: Current page within paginated list of results
          example: 1
          type: number
        per_page:
          description: Number of results per page of results
          example: 20
          type: number
        total_count:
          description: Total results available without any search parameters
          example: 2000
          type: number
      type: object
    access_certificates:
      properties:
        associated_hostnames:
          $ref: '#/components/schemas/access_associated_hostnames'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        expires_on:
          $ref: '#/components/schemas/access_timestamp'
        fingerprint:
          $ref: '#/components/schemas/access_fingerprint'
        id:
          description: The ID of the application that will use this certificate.
          type: string
        name:
          $ref: '#/components/schemas/access_certificates_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_associated_hostnames:
      description: The hostnames of the applications that will use this certificate.
      items:
        description: A fully-qualified domain name (FQDN).
        example: admin.example.com
        type: string
      type: array
    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_settings:
      additionalProperties: false
      properties:
        china_network:
          description: Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
          example: false
          type: boolean
        client_certificate_forwarding:
          description: Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
          example: true
          type: boolean
        hostname:
          description: The hostname that these settings apply to.
          example: admin.example.com
          type: string
      required:
      - hostname
      - china_network
      - client_certificate_forwarding
      title: Hostname Settings
      type: object
    access_api-response-single:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      type: object
    access_timestamp:
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    access_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/access_result_info'
      type: object
    access_uuid:
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      type: string
    access_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/access_uuid'
            type: object
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    access_fingerprint:
      description: The MD5 fingerprint of the certificate.
      example: MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91
      type: string
    access_certificates_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_certificates'
    access_certificates_components-schemas-name:
      description: The name of the certificate.
      example: Allow devs
      type: string
    access_certificates_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_certificates'
            type: array
    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_response_collection_hostnames:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_settings'
            type: array
    access_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
  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