APIs.io Engineering Platform Zone-Level 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 Zone-Level Access mTLS Authentication API
  version: 4.0.0
tags:
- name: Zone-Level Access mTLS Authentication
paths:
  /zones/{zone_id}/access/certificates:
    get:
      description: Lists all mTLS certificates.
      operationId: zone-level-access-mtls-authentication-list-mtls-certificates
      parameters:
      - in: path
        name: zone_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-2'
          description: List mTLS certificates response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List mTLS certificates
      tags:
      - Zone-Level Access mTLS Authentication
      x-api-token-group:
      - 'Access: Certificates Write'
      - 'Access: Certificates Read'
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_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_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_schemas-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.
        name:
          $ref: '#/components/schemas/access_certificates_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
      type: object
    access_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    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_certificates_components-schemas-response_collection-2:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/access_schemas-certificates'
            type: array
    access_certificates_components-schemas-name:
      description: The name of the certificate.
      example: Allow devs
      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_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