APIs.io Engineering Platform Custom Pages for an Account API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Custom Pages for an Account API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
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_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_custom_pages_response_collection:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-collection'
      - properties:
          result:
            items:
              type: object
            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_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
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          enum:
          - false
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    custom-pages_api-response-single:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
      type: object
    custom-pages_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      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-collection:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-common'
      - properties:
          result:
            items: {}
            nullable: true
            type: array
          result_info:
            $ref: '#/components/schemas/custom-pages_result_info'
      type: object
    custom-pages_custom_pages_response_single:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-single'
      - properties:
          result:
            type: object
    custom-pages_url:
      default: ''
      description: The URL associated with the custom page.
      example: http://www.example.com
      format: uri
      type: string
    custom-pages_state:
      description: The custom page state.
      enum:
      - default
      - customized
      example: default
      type: string
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/apigateway/
x-hasEquivalentPaths: true