APIs.io Engineering Platform Zone API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Zone 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: Zone
paths:
  /zones:
    get:
      description: 'Lists, searches, sorts, and filters your zones. Listing zones across more than 500 accounts

        is currently not allowed.

        '
      operationId: zones-get
      parameters:
      - examples:
          Basic Query:
            summary: Simple Query
            value: example.com
          Contains Query:
            summary: Contains Query
            value: contains:.org
          Ends With Query:
            summary: Ends With Query
            value: ends_with:arpa
          Starts With Query:
            summary: Starts With Query
            value: starts_with:dev
        in: query
        name: name
        schema:
          description: "A domain name. Optional filter operators can be provided to extend refine the search:\n  * `equal` (default)\n  * `not_equal`\n  * `starts_with`\n  * `ends_with`\n  * `contains`\n  * `starts_with_case_sensitive`\n  * `ends_with_case_sensitive`\n  * `contains_case_sensitive`\n"
          maxLength: 253
          type: string
      - in: query
        name: status
        schema:
          description: A zone status
          enum:
          - initializing
          - pending
          - active
          - moved
          type: string
      - in: query
        name: account.id
        schema:
          description: An account ID
          type: string
      - examples:
          Basic Query:
            summary: Simple Query
            value: Dev Account
          Contains Query:
            summary: Contains Query
            value: contains:Test
        in: query
        name: account.name
        schema:
          description: "An account Name. Optional filter operators can be provided to extend refine the search:\n  * `equal` (default)\n  * `not_equal`\n  * `starts_with`\n  * `ends_with`\n  * `contains`\n  * `starts_with_case_sensitive`\n  * `ends_with_case_sensitive`\n  * `contains_case_sensitive`\n"
          maxLength: 253
          type: string
      - in: query
        name: page
        schema:
          default: 1
          description: Page number of paginated results.
          minimum: 1
          type: number
      - in: query
        name: per_page
        schema:
          default: 20
          description: Number of zones per page.
          maximum: 50
          minimum: 5
          type: number
      - in: query
        name: order
        schema:
          description: Field to order zones by.
          enum:
          - name
          - status
          - account.id
          - account.name
          example: status
          type: string
      - in: query
        name: direction
        schema:
          description: Direction to order zones.
          enum:
          - asc
          - desc
          example: desc
          type: string
      - in: query
        name: match
        schema:
          default: all
          description: Whether to match all search requirements or at least one (any).
          enum:
          - any
          - all
          type: string
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: List Zones response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - properties:
                    result_info:
                      $ref: '#/components/schemas/zones_result_info'
                - properties:
                    result:
                      items:
                        $ref: '#/components/schemas/zones_zone'
                      type: array
          description: List Zones response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List Zones
      tags:
      - Zone
    post:
      operationId: zones-post
      requestBody:
        content:
          application/json:
            schema:
              properties:
                account:
                  properties:
                    id:
                      $ref: '#/components/schemas/zones_identifier'
                  type: object
                name:
                  $ref: '#/components/schemas/zones_name'
                type:
                  $ref: '#/components/schemas/zones_type'
              required:
              - name
              - account
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Create Zone response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_zone'
                  type: object
          description: Create Zone response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create Zone
      tags:
      - Zone
  /zones/{zone_id}:
    delete:
      description: Deletes an existing zone.
      operationId: zones-0-delete
      parameters:
      - in: path
        name: zone_id
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        content:
          application/json: {}
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Delete Zone response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-single-id'
          description: Delete Zone response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete Zone
      tags:
      - Zone
      x-cfPermissionsRequired:
        enum:
        - '#zone:edit'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      operationId: zones-0-get
      parameters:
      - in: path
        name: zone_id
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Zone Details response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_zone'
                  type: object
          description: Zone Details response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Zone Details
      tags:
      - Zone
      x-cfPermissionsRequired:
        enum:
        - '#zone:read'
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Edits a zone. Only one zone property can be changed at a time.
      operationId: zones-0-patch
      parameters:
      - in: path
        name: zone_id
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        content:
          application/json:
            schema:
              example:
                paused: true
              properties:
                paused:
                  $ref: '#/components/schemas/zones_paused'
                plan:
                  description: '(Deprecated) Please use the `/zones/{zone_id}/subscription` API

                    to update a zone''s plan. Changing this value will create/cancel

                    associated subscriptions. To view available plans for this zone,

                    see Zone Plans.

                    '
                  properties:
                    id:
                      $ref: '#/components/schemas/zones_identifier'
                  type: object
                type:
                  description: 'A full zone implies that DNS is hosted with Cloudflare. A partial

                    zone is typically a partner-hosted zone or a CNAME setup. This

                    parameter is only available to Enterprise customers or if it has

                    been explicitly enabled on a zone.

                    '
                  enum:
                  - full
                  - partial
                  - secondary
                  example: full
                  type: string
                vanity_name_servers:
                  $ref: '#/components/schemas/zones_vanity_name_servers'
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
          description: Edit Zone response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_zone'
                  type: object
          description: Edit Zone response
      security:
      - api_token: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Edit Zone
      tags:
      - Zone
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    zones_type:
      default: full
      description: 'A full zone implies that DNS is hosted with Cloudflare. A partial zone is

        typically a partner-hosted zone or a CNAME setup.

        '
      enum:
      - full
      - partial
      - secondary
      example: full
      type: string
    zones_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zones_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zones_messages'
          example: []
        result:
          nullable: true
          type: object
        success:
          description: Whether the API call was successful
          example: false
          type: boolean
      required:
      - success
      - errors
      - messages
      - result
      type: object
    zones_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    zones_name:
      description: The domain name
      example: example.com
      maxLength: 253
      pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
      type: string
    zones_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    zones_zone:
      properties:
        account:
          description: The account the zone belongs to
          properties:
            id:
              $ref: '#/components/schemas/zones_identifier'
            name:
              description: The name of the account
              example: Example Account Name
              type: string
          type: object
        activated_on:
          description: 'The last time proof of ownership was detected and the zone was made

            active'
          example: '2014-01-02T00:01:00.12345Z'
          format: date-time
          nullable: true
          readOnly: true
          type: string
        created_on:
          description: When the zone was created
          example: '2014-01-01T05:20:00.12345Z'
          format: date-time
          readOnly: true
          type: string
        development_mode:
          description: 'The interval (in seconds) from when development mode expires

            (positive integer) or last expired (negative integer) for the

            domain. If development mode has never been enabled, this value is 0.'
          example: 7200
          readOnly: true
          type: number
        id:
          $ref: '#/components/schemas/zones_identifier'
        meta:
          description: Metadata about the zone
          properties:
            cdn_only:
              description: The zone is only configured for CDN
              example: true
              type: boolean
            custom_certificate_quota:
              description: Number of Custom Certificates the zone can have
              example: 1
              type: integer
            dns_only:
              description: The zone is only configured for DNS
              example: true
              type: boolean
            foundation_dns:
              description: The zone is setup with Foundation DNS
              example: true
              type: boolean
            page_rule_quota:
              description: Number of Page Rules a zone can have
              example: 100
              type: integer
            phishing_detected:
              description: The zone has been flagged for phishing
              example: false
              type: boolean
            step:
              example: 2
              type: integer
          type: object
        modified_on:
          description: When the zone was last modified
          example: '2014-01-01T05:20:00.12345Z'
          format: date-time
          readOnly: true
          type: string
        name:
          description: The domain name
          example: example.com
          maxLength: 253
          pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
          type: string
        name_servers:
          description: The name servers Cloudflare assigns to a zone
          example:
          - bob.ns.cloudflare.com
          - lola.ns.cloudflare.com
          items:
            format: hostname
            type: string
          readOnly: true
          type: array
        original_dnshost:
          description: DNS host at the time of switching to Cloudflare
          example: NameCheap
          maxLength: 50
          nullable: true
          readOnly: true
          type: string
        original_name_servers:
          description: Original name servers before moving to Cloudflare
          example:
          - ns1.originaldnshost.com
          - ns2.originaldnshost.com
          items:
            format: hostname
            type: string
          nullable: true
          readOnly: true
          type: array
        original_registrar:
          description: Registrar for the domain at the time of switching to Cloudflare
          example: GoDaddy
          nullable: true
          readOnly: true
          type: string
        owner:
          description: The owner of the zone
          properties:
            id:
              $ref: '#/components/schemas/zones_identifier'
            name:
              description: Name of the owner
              example: Example Org
              type: string
            type:
              description: The type of owner
              example: organization
              type: string
          type: object
        paused:
          $ref: '#/components/schemas/zones_paused'
        status:
          description: The zone status on Cloudflare.
          enum:
          - initializing
          - pending
          - active
          - moved
          example: active
          readOnly: true
          type: string
        type:
          $ref: '#/components/schemas/zones_type'
        vanity_name_servers:
          description: An array of domains used for custom name servers. This is only available for Business and Enterprise plans.
          example:
          - ns1.example.com
          - ns2.example.com
          items:
            format: hostname
            maxLength: 253
            type: string
          type: array
      required:
      - id
      - name
      - development_mode
      - owner
      - account
      - meta
      - name_servers
      - original_name_servers
      - original_registrar
      - original_dnshost
      - created_on
      - modified_on
      - activated_on
      type: object
    zones_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/zones_messages'
        messages:
          $ref: '#/components/schemas/zones_messages'
        success:
          description: Whether the API call was successful
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    zones_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
    zones_paused:
      default: false
      description: 'Indicates whether the zone is only using Cloudflare DNS services. A

        true value means the zone will not receive security or performance

        benefits.

        '
      readOnly: true
      type: boolean
    zones_vanity_name_servers:
      description: 'An array of domains used for custom name servers. This is only

        available for Business and Enterprise plans.'
      example:
      - ns1.example.com
      - ns2.example.com
      items:
        format: hostname
        maxLength: 253
        type: string
      type: array
    zones_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/zones_api-response-common'
      - properties:
          result:
            nullable: true
            properties:
              id:
                $ref: '#/components/schemas/zones_identifier'
            required:
            - id
            type: object
      type: object
  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