APIs.io Engineering Platform Custom Pages for an Account 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 Custom Pages for an Account API
  version: 4.0.0
tags:
- name: Custom Pages for an Account
paths:
  /accounts/{account_identifier}/custom_pages:
    get:
      description: Fetches all the custom pages at the account level.
      operationId: custom-pages-for-an-account-list-custom-pages
      parameters:
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
                - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
          description: List custom pages response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
          description: List custom pages response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform List custom pages
      tags:
      - Custom Pages for an Account
      x-api-token-group:
      - Cloudflare Zero Trust PII Read
      - Account Custom Pages Write
      - Account Custom Pages Read
      - Account Settings Write
      - Account Settings Read
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
  /accounts/{account_identifier}/custom_pages/{identifier}:
    get:
      description: Fetches the details of a custom page.
      operationId: custom-pages-for-an-account-get-a-custom-page
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
                - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
          description: Get a custom page response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
          description: Get a custom page response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Get a custom page
      tags:
      - Custom Pages for an Account
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
    put:
      description: Updates the configuration of an existing custom page.
      operationId: custom-pages-for-an-account-update-a-custom-page
      parameters:
      - in: path
        name: identifier
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      - in: path
        name: account_identifier
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                state:
                  $ref: '#/components/schemas/custom-pages_state'
                url:
                  $ref: '#/components/schemas/custom-pages_url'
              required:
              - url
              - state
        required: true
      responses:
        4xx:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
                - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
          description: Update a custom page response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
          description: Update a custom page response
      security:
      - api_email: []
        api_key: []
      - api_token: []
      summary: APIs.io Engineering Platform Update a custom page
      tags:
      - Custom Pages for an Account
      x-cfPermissionsRequired:
        enum:
        - '#organization:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: false
        pro: true
components:
  schemas:
    custom-pages_custom_pages_response_single:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-single'
      - properties:
          result:
            type: object
    custom-pages_api-response-single:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    custom-pages_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/custom-pages_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/custom-pages_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
    custom-pages_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
    custom-pages_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-common'
      - properties:
          result:
            items: {}
            type:
            - array
            - 'null'
          result_info:
            $ref: '#/components/schemas/custom-pages_result_info'
      type: object
    custom-pages_state:
      description: The custom page state.
      enum:
      - default
      - customized
      example: default
      type: string
    custom-pages_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    custom-pages_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/custom-pages_messages'
        messages:
          $ref: '#/components/schemas/custom-pages_messages'
        result:
          anyOf:
          - type: object
          - items: {}
            type: array
          - type: string
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    custom-pages_custom_pages_response_collection:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-collection'
      - properties:
          result:
            items:
              type: object
            type: array
    custom-pages_url:
      default: ''
      description: The URL associated with the custom page.
      example: http://www.example.com
      format: uri
      type: string
    custom-pages_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      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