APIs.io Engineering Platform DNS Firewall API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 DNS Firewall 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: DNS Firewall
paths:
  /accounts/{account_id}/dns_firewall:
    get:
      description: List DNS Firewall clusters for an account
      operationId: dns-firewall-list-dns-firewall-clusters
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      - 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 clusters per page
          maximum: 100
          minimum: 1
          type: number
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: List DNS Firewall Clusters response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_response_collection'
          description: List DNS Firewall Clusters response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List DNS Firewall Clusters
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      - DNS Firewall Read
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    post:
      description: Create a DNS Firewall cluster
      operationId: dns-firewall-create-dns-firewall-cluster
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-post'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Create DNS Firewall Cluster response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
          description: Create DNS Firewall Cluster response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create DNS Firewall Cluster
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/dns_firewall/{dns_firewall_id}:
    delete:
      description: Delete a DNS Firewall cluster
      operationId: dns-firewall-delete-dns-firewall-cluster
      parameters:
      - in: path
        name: dns_firewall_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json: {}
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/dns-firewall_api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/dns-firewall_identifier'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Delete DNS Firewall Cluster response failure
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_api-response-single'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/dns-firewall_identifier'
          description: Delete DNS Firewall Cluster response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete DNS Firewall Cluster
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    get:
      description: Show a single DNS Firewall cluster for an account
      operationId: dns-firewall-dns-firewall-cluster-details
      parameters:
      - in: path
        name: dns_firewall_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: DNS Firewall Cluster Details response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
          description: DNS Firewall Cluster Details response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform DNS Firewall Cluster Details
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      - DNS Firewall Read
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Modify the configuration of a DNS Firewall cluster
      operationId: dns-firewall-update-dns-firewall-cluster
      parameters:
      - in: path
        name: dns_firewall_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-patch'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Update DNS Firewall Cluster response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_single_response'
          description: Update DNS Firewall Cluster response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update DNS Firewall Cluster
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
  /accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns:
    get:
      description: Show reverse DNS configuration (PTR records) for a DNS Firewall cluster
      operationId: dns-firewall-show-dns-firewall-cluster-reverse-dns
      parameters:
      - in: path
        name: dns_firewall_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Show DNS Firewall Cluster Reverse DNS response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
          description: Show DNS Firewall Cluster Reverse DNS response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Show DNS Firewall Cluster Reverse DNS
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      - DNS Firewall Read
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:read'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
    patch:
      description: Update reverse DNS configuration (PTR records) for a DNS Firewall cluster
      operationId: dns-firewall-update-dns-firewall-cluster-reverse-dns
      parameters:
      - in: path
        name: dns_firewall_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/dns-firewall_identifier'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns-patch'
        required: true
      responses:
        4XX:
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
                - $ref: '#/components/schemas/dns-firewall_api-response-common-failure'
          description: Update DNS Firewall Cluster Reverse DNS response failure
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-firewall_dns_firewall_reverse_dns_response'
          description: Update DNS Firewall Cluster Reverse DNS response
      security:
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update DNS Firewall Cluster Reverse DNS
      tags:
      - DNS Firewall
      x-api-token-group:
      - DNS Firewall Write
      x-cfPermissionsRequired:
        enum:
        - '#dns_records:edit'
      x-cfPlanAvailability:
        business: false
        enterprise: true
        free: false
        pro: false
components:
  schemas:
    dns-firewall_maximum_cache_ttl:
      default: 900
      description: Maximum DNS cache TTL This setting sets an upper bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Higher TTLs will be decreased to the maximum defined here for caching purposes.
      example: 900
      maximum: 36000
      minimum: 30
      type: number
    dns-firewall_dns_firewall_single_response:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-response'
    dns-firewall_dns-firewall-cluster:
      properties:
        attack_mitigation:
          $ref: '#/components/schemas/dns-firewall_attack_mitigation'
        deprecate_any_requests:
          $ref: '#/components/schemas/dns-firewall_deprecate_any_requests'
        ecs_fallback:
          $ref: '#/components/schemas/dns-firewall_ecs_fallback'
        maximum_cache_ttl:
          $ref: '#/components/schemas/dns-firewall_maximum_cache_ttl'
        minimum_cache_ttl:
          $ref: '#/components/schemas/dns-firewall_minimum_cache_ttl'
        name:
          $ref: '#/components/schemas/dns-firewall_name'
        negative_cache_ttl:
          $ref: '#/components/schemas/dns-firewall_negative_cache_ttl'
        ratelimit:
          $ref: '#/components/schemas/dns-firewall_ratelimit'
        retries:
          $ref: '#/components/schemas/dns-firewall_retries'
        upstream_ips:
          $ref: '#/components/schemas/dns-firewall_upstream_ips'
      type: object
    dns-firewall_messages:
      example: []
      items:
        properties:
          code:
            minimum: 1000
            type: integer
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      type: array
    dns-firewall_dns-firewall-cluster-post:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster'
      required:
      - name
      - upstream_ips
      type: object
    dns-firewall_deprecate_any_requests:
      description: Whether to refuse to answer queries for the ANY type
      example: true
      type: boolean
    dns-firewall_modified_on:
      description: Last modification of DNS Firewall cluster
      example: '2014-01-01T05:20:00.12345Z'
      format: date-time
      type: string
    dns-firewall_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_api-response-common'
      - properties:
          result_info:
            $ref: '#/components/schemas/dns-firewall_result_info'
      type: object
    dns-firewall_dns_firewall_ips:
      example:
      - 203.0.113.1
      - 203.0.113.254
      - 2001:DB8:AB::CF
      - 2001:DB8:CD::CF
      items:
        anyOf:
        - description: Cloudflare-assigned DNS IPv4 address
          example: 203.0.113.1
          format: ipv4
          type: string
        - description: Cloudflare-assigned DNS IPv6 address
          example: 2001:DB8:ab::CF
          format: ipv6
          type: string
      type: array
    dns-firewall_ratelimit:
      description: Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster)
      example: 600
      maximum: 1e+09
      minimum: 100
      nullable: true
      type: number
    dns-firewall_retries:
      default: 2
      description: Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt)
      example: 2
      maximum: 2
      minimum: 0
      type: number
    dns-firewall_dns-firewall-reverse-dns-response:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns'
      required:
      - ptr
      type: object
    dns-firewall_identifier:
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      type: string
    dns-firewall_dns-firewall-cluster-patch:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster'
      type: object
    dns-firewall_upstream_ips:
      example:
      - 192.0.2.1
      - 198.51.100.1
      - 2001:DB8:100::CF
      items:
        anyOf:
        - description: Upstream DNS Server IPv4 address
          example: 192.0.2.1
          format: ipv4
          type: string
        - description: Upstream DNS Server IPv6 address
          example: 2001:DB8:100::CF
          format: ipv6
          type: string
      minLength: 1
      type: array
    dns-firewall_dns-firewall-cluster-response:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster'
      - properties:
          dns_firewall_ips:
            $ref: '#/components/schemas/dns-firewall_dns_firewall_ips'
          id:
            $ref: '#/components/schemas/dns-firewall_identifier'
          modified_on:
            $ref: '#/components/schemas/dns-firewall_modified_on'
        required:
        - id
        - dns_firewall_ips
        - modified_on
        type: object
      required:
      - name
      - upstream_ips
      - minimum_cache_ttl
      - maximum_cache_ttl
      - negative_cache_ttl
      - deprecate_any_requests
      - ecs_fallback
      - ratelimit
      - retries
      type: object
    dns-firewall_negative_cache_ttl:
      description: Negative DNS cache TTL This setting controls how long DNS Firewall should cache negative responses (e.g., NXDOMAIN) from the upstream servers.
      example: 900
      maximum: 36000
      minimum: 30
      nullable: true
      type: number
    dns-firewall_ecs_fallback:
      description: Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent
      example: false
      type: boolean
    dns-firewall_attack_mitigation:
      description: Attack mitigation settings
      nullable: true
      properties:
        enabled:
          description: When enabled, automatically mitigate random-prefix attacks to protect upstream DNS servers
          example: true
          type: boolean
        only_when_upstream_unhealthy:
          default: true
          description: Only mitigate attacks when upstream servers seem unhealthy
          example: false
          type: boolean
      type: object
    dns-firewall_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
    dns-firewall_dns_firewall_response_collection:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_api-response-collection'
      - properties:
          result:
            items:
              $ref: '#/components/schemas/dns-firewall_dns-firewall-cluster-response'
            type: array
    dns-firewall_api-response-common:
      properties:
        errors:
          $ref: '#/components/schemas/dns-firewall_messages'
        messages:
          $ref: '#/components/schemas/dns-firewall_messages'
        success:
          description: Whether the API call was successful
          enum:
          - true
          example: true
          type: boolean
      required:
      - success
      - errors
      - messages
      type: object
    dns-firewall_dns-firewall-reverse-dns-patch:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns'
      type: object
    dns-firewall_dns-firewall-reverse-dns:
      properties:
        ptr:
          additionalProperties:
            description: PTR record content
            type: string
          description: Map of cluster IP addresses to PTR record contents
          type: object
      type: object
    dns-firewall_api-response-single:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_api-response-common'
      type: object
    dns-firewall_name:
      description: DNS Firewall cluster name
      example: My Awesome DNS Firewall cluster
      maxLength: 160
      minLength: 1
      type: string
    dns-firewall_dns_firewall_reverse_dns_response:
      allOf:
      - $ref: '#/components/schemas/dns-firewall_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dns-firewall_dns-firewall-reverse-dns-response'
    dns-firewall_minimum_cache_ttl:
      default: 60
      description: Minimum DNS cache TTL This setting sets a lower bound on DNS TTLs for purposes of caching between DNS Firewall and the upstream servers. Lower TTLs will be increased to the minimum defined here for caching purposes.
      example: 60
      maximum: 36000
      minimum: 30
      type: number
    dns-firewall_api-response-common-failure:
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dns-firewall_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dns-firewall_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
  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