APIs.io Engineering Platform Origin CA 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 Origin CA API
  version: 4.0.0
tags:
- name: Origin CA
paths:
  /certificates:
    get:
      description: List all existing Origin CA certificates for a given zone. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).
      operationId: origin-ca-list-certificates
      parameters:
      - in: query
        name: zone_id
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: List Certificates response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_collection'
          description: List Certificates response
      security:
      - user_service_key: []
      summary: APIs.io Engineering Platform List Certificates
      tags:
      - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Create an Origin CA certificate. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).
      operationId: origin-ca-create-certificate
      requestBody:
        content:
          application/json:
            schema:
              properties:
                csr:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_csr'
                hostnames:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_hostnames'
                request_type:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_request_type'
                requested_validity:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_requested_validity'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Create Certificate response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
          description: Create Certificate response
      security:
      - user_service_key: []
      summary: APIs.io Engineering Platform Create Certificate
      tags:
      - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /certificates/{certificate_id}:
    delete:
      description: Revoke an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).
      operationId: origin-ca-revoke-certificate
      parameters:
      - in: path
        name: certificate_id
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_revoke_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Revoke Certificate response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_revoke_response'
          description: Revoke Certificate response
      security:
      - user_service_key: []
      summary: APIs.io Engineering Platform Revoke Certificate
      tags:
      - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Get an existing Origin CA certificate by its serial number. Use your Origin CA Key as your User Service Key when calling this endpoint ([see above](#requests)).
      operationId: origin-ca-get-certificate
      parameters:
      - in: path
        name: certificate_id
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
          description: Get Certificate response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_response_single'
          description: Get Certificate response
      security:
      - user_service_key: []
      summary: APIs.io Engineering Platform Get Certificate
      tags:
      - Origin CA
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    tls-certificates-and-hostnames_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
        messages:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    tls-certificates-and-hostnames_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    tls-certificates-and-hostnames_components-schemas-certificate:
      description: The Origin CA certificate. Will be newline-encoded.
      example: '-----BEGIN CERTIFICATE-----

        MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV

        BAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln

        aUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG

        9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo

        wp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c

        1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI

        WDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ

        wIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR

        BPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ

        KoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D

        hJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY

        Q4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/

        ZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn

        29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2

        97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=

        -----END CERTIFICATE-----'
      readOnly: true
      type: string
    tls-certificates-and-hostnames_certificate_revoke_response:
      allOf:
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
              revoked_at:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_revoked_at'
        type: object
    tls-certificates-and-hostnames_schemas-certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_certificates'
        type: object
    tls-certificates-and-hostnames_requested_validity:
      default: 5475
      description: The number of days for which the certificate should be valid.
      enum:
      - 7
      - 30
      - 90
      - 365
      - 730
      - 1095
      - 5475
      example: 5475
      type: number
    tls-certificates-and-hostnames_schemas-certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_certificates'
            type: array
        type: object
    tls-certificates-and-hostnames_hostnames:
      description: Array of hostnames or wildcard names (e.g., *.example.com) bound to the certificate.
      example:
      - example.com
      - '*.example.com'
      items:
        type: string
      type: array
    tls-certificates-and-hostnames_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/tls-certificates-and-hostnames_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
    tls-certificates-and-hostnames_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
    tls-certificates-and-hostnames_certificates:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate'
        csr:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_csr'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-expires_on'
        hostnames:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostnames'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        request_type:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_request_type'
        requested_validity:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_requested_validity'
      required:
      - hostnames
      - csr
      - requested_validity
      - request_type
      type: object
    tls-certificates-and-hostnames_revoked_at:
      description: When the certificate was revoked.
      example: '2024-09-06T18:43:47.928893Z'
      format: date-time
      readOnly: true
      type: string
    tls-certificates-and-hostnames_request_type:
      description: Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
      enum:
      - origin-rsa
      - origin-ecc
      - keyless-certificate
      example: origin-rsa
      type: string
    tls-certificates-and-hostnames_csr:
      description: The Certificate Signing Request (CSR). Must be newline-encoded.
      example: '-----BEGIN CERTIFICATE REQUEST-----

        MIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz

        Y28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI

        hvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL

        Hu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8

        4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc

        N8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi

        g7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I

        uOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG

        CSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt

        cGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx

        pTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/

        auRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH

        yc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J

        hXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs

        dcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==

        -----END CERTIFICATE REQUEST-----'
      type: string
    tls-certificates-and-hostnames_api-response-single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
      type: object
    tls-certificates-and-hostnames_schemas-expires_on:
      description: When the certificate will expire.
      example: 2014-01-01 05:20:00 +0000 UTC
      readOnly: true
      type: string
    tls-certificates-and-hostnames_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_result_info'
      type: object
    tls-certificates-and-hostnames_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      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