APIs.io Engineering Platform Pages Domains 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 Pages Domains API
  version: 4.0.0
tags:
- name: Pages Domains
paths:
  /accounts/{account_id}/pages/projects/{project_name}/domains:
    get:
      description: Fetch a list of all domains associated with a Pages project.
      operationId: pages-domains-get-domains
      parameters:
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_domain-response-collection'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get domains response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-collection'
          description: Get domains response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get domains
      tags:
      - Pages Domains
    post:
      description: Add a new domain for the Pages project.
      operationId: pages-domains-add-domain
      parameters:
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pages_domains-post'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_domain-response-single'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Add domain response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-single'
          description: Add domain response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Add domain
      tags:
      - Pages Domains
  /accounts/{account_id}/pages/projects/{project_name}/domains/{domain_name}:
    delete:
      description: Delete a Pages project's domain.
      operationId: pages-domains-delete-domain
      parameters:
      - in: path
        name: domain_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_domain_name'
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                - example:
                    errors: []
                    messages: []
                    result: null
                    success: true
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Delete domain response failure.
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_api-response-common'
                - properties:
                    result:
                      type:
                      - object
                      - 'null'
                  type: object
          description: Delete domain response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete domain
      tags:
      - Pages Domains
    get:
      description: Fetch a single domain.
      operationId: pages-domains-get-domain
      parameters:
      - in: path
        name: domain_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_domain_name'
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_domain-response-single'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Get domain response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-single'
          description: Get domain response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get domain
      tags:
      - Pages Domains
    patch:
      description: Retry the validation status of a single domain.
      operationId: pages-domains-patch-domain
      parameters:
      - in: path
        name: domain_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_domain_name'
      - in: path
        name: project_name
        required: true
        schema:
          $ref: '#/components/schemas/pages_project_name'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/pages_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pages_domain-response-single'
                - $ref: '#/components/schemas/pages_api-response-common-failure'
          description: Patch domain response failure.
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pages_domain-response-single'
          description: Patch domain response.
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Patch domain
      tags:
      - Pages Domains
components:
  schemas:
    pages_domain-object:
      properties:
        certificate_authority:
          enum:
          - google
          - lets_encrypt
          example: lets_encrypt
          readOnly: true
          type: string
        created_on:
          readOnly: true
          type: string
        domain_id:
          readOnly: true
          type: string
        id:
          readOnly: true
          type: string
        name:
          example: example.com
          type: string
        status:
          enum:
          - initializing
          - pending
          - active
          - deactivated
          - blocked
          - error
          readOnly: true
          type: string
        validation_data:
          properties:
            error_message:
              type: string
            method:
              enum:
              - http
              - txt
              type: string
            status:
              enum:
              - initializing
              - pending
              - active
              - deactivated
              - error
              type: string
            txt_name:
              type: string
            txt_value:
              type: string
          readOnly: true
          type: object
        verification_data:
          properties:
            error_message:
              type: string
            status:
              enum:
              - pending
              - active
              - deactivated
              - blocked
              - error
              type: string
          readOnly: true
          type: object
        zone_tag:
          readOnly: true
          type: string
      type: object
    pages_domain-response-collection:
      allOf:
      - $ref: '#/components/schemas/pages_api-response-common'
      - $ref: '#/components/schemas/pages_api-response-pagination'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/pages_domain-object'
            type: array
    pages_api-response-pagination:
      properties:
        result_info:
          properties:
            count:
              description: The number of items on the current page.
              example: 1
              type: integer
            page:
              description: The page currently being requested.
              example: 1
              type: integer
            per_page:
              description: The number of items per page being returned.
              example: 100
              type: integer
            total_count:
              description: The total count of items.
              example: 1
              type: integer
            total_pages:
              description: The total count of pages.
              example: 1
              type: integer
          required:
          - page
          - per_page
          - count
          - total_count
          type: object
      type: object
    pages_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      type: string
    pages_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    pages_domain-response-single:
      allOf:
      - $ref: '#/components/schemas/pages_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/pages_domain-object'
    pages_domain_name:
      description: Name of the domain.
      example: this-is-my-domain-01.com
      pattern: ^[a-z0-9][a-z0-9-]*$
      type: string
    pages_api-response-single:
      allOf:
      - $ref: '#/components/schemas/pages_api-response-common'
      - properties:
          result:
            type:
            - object
            - 'null'
      type: object
    pages_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/pages_messages'
        messages:
          $ref: '#/components/schemas/pages_messages'
        success:
          description: Whether the API call was successful
          enum:
          - false
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    pages_domains-post:
      properties:
        name:
          example: example.com
          type: string
      type: object
    pages_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/pages_messages'
          example:
          - code: 7003
            message: No route for the URI.
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/pages_messages'
          example: []
        result:
          type:
          - object
          - 'null'
        success:
          description: Whether the API call was successful.
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    pages_project_name:
      description: Name of the project.
      example: this-is-my-project-01
      pattern: ^[a-z0-9][a-z0-9-]*$
      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