Update DNS Firewall Cluster

Modify a DNS Firewall Cluster configuration.

Request

Path Params

identifier

string

required

account_identifier

string

required

Body Params application/json

attack_mitigation

object | null

attack_mitigation

optional

Attack mitigation settings.

enabled

boolean

optional

When enabled, random-prefix attacks are automatically mitigated and the origin DNS servers protected.

Example:

true

only_when_origin_unhealthy

boolean

optional

Only mitigate attacks when origin servers seem unhealthy.

Default:

true

Example:

false

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"]

string <ipv4>

optional

Origin DNS Server IPv4 Address.

Example:

203.0.113.1

string <ipv6>

optional

Origin DNS Server IPv6 Address.

Example:

2001:DB8:ab::CF

ecs_fallback

boolean

ecs_fallback

required

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

Example:

false

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:

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"]

string <ipv4>

optional

Origin DNS Server IPv4 Address.

Example:

192.0.2.1

string <ipv6>

optional

Origin DNS Server IPv6 Address.

Example:

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:

Example

{
    "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,
    "maximum_cache_ttl": 900,
    "minimum_cache_ttl": 60,
    "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
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Update DNS Firewall Cluster response

application/json

Body

allOf {2}

optional

object (api-response-single)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

object

optional

result

object (dns-firewall)

optional

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
}

🟢200Update DNS Firewall Cluster response failure