List DNS Firewall Clusters

List configured DNS Firewall clusters for an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (dns-firewall) {13}]

allOf {2}

One of

array[object (dns-firewall) {13}]

object

attack_mitigation

object | null

attack_mitigation

optional

Attack mitigation settings.

deprecate_any_requests

boolean

deprecate_any_requests

required

Deprecate the response to ANY requests.

Example:

true

dns_firewall_ips

array [anyOf]

dns_firewall_ips

required

Example:

["203.0.113.1","203.0.113.254","2001:DB8:AB::CF","2001:DB8:CD::CF"]

ecs_fallback

boolean

ecs_fallback

required

Forward client IP (resolver) subnet if no EDNS Client Subnet is sent.

Example:

false

string

common_components-schemas-identifier

read-onlyrequired

Identifier

<= 32 characters

Example:

023e105f4ecef8ad9ca31a8372d0c353

maximum_cache_ttl

number

maximum_cache_ttl

required

Maximum DNS Cache TTL.

>= 30<= 36000

Default:

900

Example:

900

minimum_cache_ttl

number

minimum_cache_ttl

required

Minimum DNS Cache TTL.

>= 30<= 36000

Default:

Example:

modified_on

string <date-time>

schemas-modified_on

read-onlyrequired

Last modification of DNS Firewall cluster.

Example:

2014-01-01T05:20:00.12345Z

name

string

dns-firewall_components-schemas-name

required

DNS Firewall Cluster Name.

<= 160 characters

Example:

My Awesome DNS Firewall cluster

negative_cache_ttl

number | null

negative_cache_ttl

optional

Negative DNS Cache TTL.

>= 30<= 36000

Example:

900

origin_ips

array [anyOf]

origin_ips

required

Example:

["192.0.2.1","198.51.100.1","2001:DB8:100::CF"]

ratelimit

number | null

ratelimit

optional

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

>= 100<= 1000000000

Example:

600

retries

number

retries

optional

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

>= 0<= 2

Default:

Example:

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "attack_mitigation": {
                "enabled": true,
                "only_when_origin_unhealthy": false
            },
            "deprecate_any_requests": true,
            "dns_firewall_ips": [
                "203.0.113.1",
                "203.0.113.254",
                "2001:DB8:AB::CF",
                "2001:DB8:CD::CF"
            ],
            "ecs_fallback": false,
            "id": "023e105f4ecef8ad9ca31a8372d0c353",
            "maximum_cache_ttl": 900,
            "minimum_cache_ttl": 60,
            "modified_on": "2014-01-01T05:20:00.12345Z",
            "name": "My Awesome DNS Firewall cluster",
            "negative_cache_ttl": 900,
            "origin_ips": [
                "192.0.2.1",
                "198.51.100.1",
                "2001:DB8:100::CF"
            ],
            "ratelimit": 600,
            "retries": 2
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List DNS Firewall Clusters

Request

Request samples

Responses