APIs.io Engineering Platform Secondary DNS (ACL) API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Secondary DNS (ACL) 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: Secondary DNS (ACL)
paths:
  /accounts/{account_id}/secondary_dns/acls:
    get:
      description: List ACLs.
      operationId: secondary-dns-(-acl)-list-ac-ls
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: List ACLs response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-response_collection'
          description: List ACLs response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List ACLs
      tags:
      - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create ACL.
      operationId: secondary-dns-(-acl)-create-acl
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                ip_range:
                  $ref: '#/components/schemas/secondary-dns_ip_range'
                name:
                  $ref: '#/components/schemas/secondary-dns_acl_components-schemas-name'
              required:
              - name
              - ip_range
              type: object
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Create ACL response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
          description: Create ACL response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create ACL
      tags:
      - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/secondary_dns/acls/{acl_id}:
    delete:
      description: Delete ACL.
      operationId: secondary-dns-(-acl)-delete-acl
      parameters:
      - in: path
        name: acl_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Delete ACL response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-id_response'
          description: Delete ACL response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete ACL
      tags:
      - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Get ACL.
      operationId: secondary-dns-(-acl)-acl-details
      parameters:
      - in: path
        name: acl_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: ACL Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
          description: ACL Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform ACL Details
      tags:
      - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    put:
      description: Modify ACL.
      operationId: secondary-dns-(-acl)-update-acl
      parameters:
      - in: path
        name: acl_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_account_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_acl'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
          description: Update ACL response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_components-schemas-single_response'
          description: Update ACL response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update ACL
      tags:
      - Secondary DNS (ACL)
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
        - '#organization:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    secondary-dns_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/secondary-dns_result_info'
      type: object
    secondary-dns_account_identifier:
      example: 01a7362d577a6c3019a474fd6f485823
      readOnly: true
      type: string
    secondary-dns_components-schemas-identifier:
      example: 23ff594956f20c2a721606e94745a8aa
      readOnly: true
      type: string
    secondary-dns_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/secondary-dns_messages'
        messages:
          $ref: '#/components/schemas/secondary-dns_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    secondary-dns_acl_components-schemas-name:
      description: The name of the acl.
      example: my-acl-1
      type: string
    secondary-dns_ip_range:
      description: Allowed IPv4/IPv6 address range of primary or secondary nameservers. This will be applied for the entire account. The IP range is used to allow additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR requests from for primary zones. CIDRs are limited to a maximum of /24 for IPv4 and /64 for IPv6 respectively.
      example: 192.0.2.53/28
      type: string
    secondary-dns_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
            type: object
    secondary-dns_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    secondary-dns_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/secondary-dns_acl'
    secondary-dns_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
    secondary-dns_api-response-single:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-common'
      type: object
    secondary-dns_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/secondary-dns_acl'
            type: array
    secondary-dns_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/secondary-dns_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/secondary-dns_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
    secondary-dns_acl:
      properties:
        id:
          $ref: '#/components/schemas/secondary-dns_components-schemas-identifier'
        ip_range:
          $ref: '#/components/schemas/secondary-dns_ip_range'
        name:
          $ref: '#/components/schemas/secondary-dns_acl_components-schemas-name'
      required:
      - id
      - name
      - ip_range
      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