APIs.io Engineering Platform DNS Firewall API

The DNS Firewall API from APIs.io Engineering Platform — 3 operation(s) for dns firewall.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 7 operations across 3 paths, and defines 29 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

7 operations 3 paths 29 schemas 1 DELETE3 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

2015-07-09

Base URL

https://{bucketname}.s3.amazonaws.com

Authentication

API Key

Contact

Mike Ralphson

License

Apache 2.0 License

View terms

Resource Areas

Authentication & Security 1

APIs.io Engineering Platform DNS Firewall API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

hmac — Amazon Signature authorization v4

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

DNS Firewall 7

GET

/accounts/{account_id}/dns_firewall

APIs.io Engineering Platform List DNS Firewall Clusters

dns-firewall-list-dns-firewall-clusters 3 params → 4XX200

POST

/accounts/{account_id}/dns_firewall

APIs.io Engineering Platform Create DNS Firewall Cluster

dns-firewall-create-dns-firewall-cluster 1 param body → 4XX200

DELETE

/accounts/{account_id}/dns_firewall/{dns_firewall_id}

APIs.io Engineering Platform Delete DNS Firewall Cluster

dns-firewall-delete-dns-firewall-cluster 2 params body → 4XX200

GET

/accounts/{account_id}/dns_firewall/{dns_firewall_id}

APIs.io Engineering Platform DNS Firewall Cluster Details

dns-firewall-dns-firewall-cluster-details 2 params → 4XX200

PATCH

/accounts/{account_id}/dns_firewall/{dns_firewall_id}

APIs.io Engineering Platform Update DNS Firewall Cluster

dns-firewall-update-dns-firewall-cluster 2 params body → 4XX200

GET

/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns

APIs.io Engineering Platform Show DNS Firewall Cluster Reverse DNS

dns-firewall-show-dns-firewall-cluster-reverse-dns 2 params → 4XX200

PATCH

/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns

APIs.io Engineering Platform Update DNS Firewall Cluster Reverse DNS

dns-firewall-update-dns-firewall-cluster-reverse-dns 2 params body → 4XX200

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are dns-firewall_dns-firewall-cluster (10 properties), dns-firewall_api-response-common-failure (4 properties), dns-firewall_result_info (4 properties), dns-firewall_api-response-common (3 properties). Each schema is shown below with its type and property counts.

dns-firewall_maximum_cache_ttl

number

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 d…

dns-firewall_dns_firewall_single_response

dns-firewall_dns-firewall-cluster

object

10 properties

dns-firewall_messages

array

dns-firewall_dns-firewall-cluster-post

object

2 required

dns-firewall_deprecate_any_requests

boolean

Whether to refuse to answer queries for the ANY type

dns-firewall_modified_on

string

Last modification of DNS Firewall cluster

dns-firewall_api-response-collection

object

dns-firewall_dns_firewall_ips

array

dns-firewall_ratelimit

number

Ratelimit in queries per second per datacenter (applies to DNS queries sent to the upstream nameservers configured on the cluster)

dns-firewall_retries

number

Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt)

dns-firewall_dns-firewall-reverse-dns-response

object

1 required

dns-firewall_identifier

string

Identifier

dns-firewall_dns-firewall-cluster-patch

object

dns-firewall_upstream_ips

array

dns-firewall_dns-firewall-cluster-response

object

9 required

dns-firewall_negative_cache_ttl

number

Negative DNS cache TTL This setting controls how long DNS Firewall should cache negative responses (e.g., NXDOMAIN) from the upstream servers.

dns-firewall_ecs_fallback

boolean

Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent

dns-firewall_attack_mitigation

object

Attack mitigation settings

2 properties

dns-firewall_result_info

object

4 properties

dns-firewall_dns_firewall_response_collection

dns-firewall_api-response-common

object

3 properties 3 required

dns-firewall_dns-firewall-reverse-dns-patch

object

dns-firewall_dns-firewall-reverse-dns

object

1 property

dns-firewall_api-response-single

object

dns-firewall_name

string

DNS Firewall cluster name

dns-firewall_dns_firewall_reverse_dns_response

dns-firewall_minimum_cache_ttl

number

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 inc…

dns-firewall_api-response-common-failure

object

4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

#DNS Firewall

← Back to A APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

APIs.io Engineering Platform DNS Firewall API

Metadata

Authentication & Security 1

Paths & Operations 7

Schemas 29

Specification

Source

API Details

Provider

Explore more