---
title: DNS Firewall Cluster Details
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[DNS Firewall](https://developers.cloudflare.com/api/typescript/resources/dns%5Ffirewall)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# DNS Firewall Cluster Details

client.dnsFirewall.get(stringdnsFirewallID, DNSFirewallGetParams { account\_id } params, RequestOptionsoptions?): [DNSFirewallGetResponse](https://developers.cloudflare.com/api/typescript/resources/dns%5Ffirewall#%28resource%29%20dns%5Ffirewall%20%3E%20%28model%29%20dns%5Ffirewall%5Fget%5Fresponse%20%3E%20%28schema%29) { id, deprecate\_any\_requests, dns\_firewall\_ips, 10 more } 

GET/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id}

Show a single DNS Firewall cluster for an account

##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).

**Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY`

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### Accepted Permissions (at least one required)

`DNS Firewall Write` `DNS Firewall Read`

##### ParametersExpand Collapse 

dnsFirewallID: string

Identifier.

maxLength32

params: DNSFirewallGetParams { account\_id } 

account\_id: string

Identifier.

maxLength32

##### ReturnsExpand Collapse 

DNSFirewallGetResponse { id, deprecate\_any\_requests, dns\_firewall\_ips, 10 more } 

id: string

Identifier.

maxLength32

deprecate\_any\_requests: boolean

Whether to refuse to answer queries for the ANY type

dns\_firewall\_ips: Array<[FirewallIPs](https://developers.cloudflare.com/api/typescript/resources/dns%5Ffirewall#%28resource%29%20dns%5Ffirewall%20%3E%20%28model%29%20firewall%5Fips%20%3E%20%28schema%29)\>

ecs\_fallback: boolean

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

maximum\_cache\_ttl: number

By default, Cloudflare attempts to cache responses for as long as indicated by the TTL received from upstream nameservers. This setting sets an upper bound on this duration. For caching purposes, higher TTLs will be decreased to the maximum value defined by this setting.

This setting does not affect the TTL value in the DNS response Cloudflare returns to clients. Cloudflare will always forward the TTL value received from upstream nameservers.

maximum36000

minimum30

minimum\_cache\_ttl: number

By default, Cloudflare attempts to cache responses for as long as indicated by the TTL received from upstream nameservers. This setting sets a lower bound on this duration. For caching purposes, lower TTLs will be increased to the minimum value defined by this setting.

This setting does not affect the TTL value in the DNS response Cloudflare returns to clients. Cloudflare will always forward the TTL value received from upstream nameservers.

Note that, even with this setting, there is no guarantee that a response will be cached for at least the specified duration. Cached responses may be removed earlier for capacity or other operational reasons.

maximum36000

minimum30

modified\_on: string

Last modification of DNS Firewall cluster

formatdate-time

name: string

DNS Firewall cluster name

maxLength160

minLength1

negative\_cache\_ttl: number | null

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

This setting does not affect the TTL value in the DNS response Cloudflare returns to clients. Cloudflare will always forward the TTL value received from upstream nameservers.

maximum36000

minimum30

ratelimit: number | null

Maximum number of DNS queries per second that will be forwarded to your upstream nameservers. The limit is enforced per server, where each server receives a fraction of the configured value. The actual aggregate rate for a data center may vary depending on how many servers are present. Responses served from cache do not count toward this limit. Set to null to disable rate limiting.

maximum1000000000

minimum100

retries: number

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

maximum2

minimum0

upstream\_ips: Array<[UpstreamIPs](https://developers.cloudflare.com/api/typescript/resources/dns%5Ffirewall#%28resource%29%20dns%5Ffirewall%20%3E%20%28model%29%20upstream%5Fips%20%3E%20%28schema%29)\>

minLength1

attack\_mitigation?: [AttackMitigation](https://developers.cloudflare.com/api/typescript/resources/dns%5Ffirewall#%28resource%29%20dns%5Ffirewall%20%3E%20%28model%29%20attack%5Fmitigation%20%3E%20%28schema%29) { enabled, only\_when\_upstream\_unhealthy } | null

Attack mitigation settings

enabled?: boolean

When enabled, automatically mitigate random-prefix attacks to protect upstream DNS servers

only\_when\_upstream\_unhealthy?: boolean

Only mitigate attacks when upstream servers seem unhealthy

### DNS Firewall Cluster Details

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const dnsFirewall = await client.dnsFirewall.get('023e105f4ecef8ad9ca31a8372d0c353', {
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(dnsFirewall.id);
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "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,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "My Awesome DNS Firewall cluster",
    "negative_cache_ttl": 900,
    "ratelimit": 600,
    "retries": 2,
    "upstream_ips": [
      "192.0.2.1",
      "198.51.100.1",
      "2001:DB8:100::CF"
    ],
    "attack_mitigation": {
      "enabled": true,
      "only_when_upstream_unhealthy": false
    }
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "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,
    "modified_on": "2014-01-01T05:20:00.12345Z",
    "name": "My Awesome DNS Firewall cluster",
    "negative_cache_ttl": 900,
    "ratelimit": 600,
    "retries": 2,
    "upstream_ips": [
      "192.0.2.1",
      "198.51.100.1",
      "2001:DB8:100::CF"
    ],
    "attack_mitigation": {
      "enabled": true,
      "only_when_upstream_unhealthy": false
    }
  }
}
```