List DNS Firewall Clusters

client.dnsFirewall.list(, ?): V4PagePaginationArray<DNSFirewallListResponse { id, deprecate_any_requests, dns_firewall_ips, 10 more } >

GET/accounts/{account_id}/dns_firewall

List DNS Firewall clusters for an account

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a 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 WriteDNS Firewall Read

ParametersExpand Collapse

params: DNSFirewallListParams { account_id, page, per_page }

account_id: string

Path param: Identifier.

maxLength32

page?: number

Query param: Page number of paginated results

minimum1

per_page?: number

Query param: Number of clusters per page

maximum100

minimum1

ReturnsExpand Collapse

DNSFirewallListResponse { 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>

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

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

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>

minLength1

attack_mitigation?: AttackMitigation { 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

List DNS Firewall Clusters

import Cloudflare from 'cloudflare';

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

// Automatically fetches more pages as needed.
for await (const dnsFirewallListResponse of client.dnsFirewall.list({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(dnsFirewallListResponse.id);
}

{
  "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
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Returns Examples

{
  "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
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}