--- title: DNS Firewall --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # DNS Firewall ##### [List DNS Firewall Clusters](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/methods/list) client.dnsFirewall.list(DNSFirewallListParams {account\_id, page, per\_page } params, RequestOptionsoptions?): V4PagePaginationArray< [DNSFirewallListResponse]() {id, deprecate\_any\_requests, dns\_firewall\_ips, 10 more } > GET/accounts/{account\_id}/dns\_firewall ##### [DNS Firewall Cluster Details](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/methods/get) client.dnsFirewall.get(stringdnsFirewallID, DNSFirewallGetParams {account\_id } params, RequestOptionsoptions?): [DNSFirewallGetResponse]() {id, deprecate\_any\_requests, dns\_firewall\_ips, 10 more } GET/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id} ##### [Create DNS Firewall Cluster](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/methods/create) client.dnsFirewall.create(DNSFirewallCreateParams {account\_id, name, upstream\_ips, 9 more } params, RequestOptionsoptions?): [DNSFirewallCreateResponse]() {id, deprecate\_any\_requests, dns\_firewall\_ips, 10 more } POST/accounts/{account\_id}/dns\_firewall ##### [Update DNS Firewall Cluster](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/methods/edit) client.dnsFirewall.edit(stringdnsFirewallID, DNSFirewallEditParams {account\_id, attack\_mitigation, deprecate\_any\_requests, 8 more } params, RequestOptionsoptions?): [DNSFirewallEditResponse]() {id, deprecate\_any\_requests, dns\_firewall\_ips, 10 more } PATCH/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id} ##### [Delete DNS Firewall Cluster](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/methods/delete) client.dnsFirewall.delete(stringdnsFirewallID, DNSFirewallDeleteParams {account\_id } params, RequestOptionsoptions?): [DNSFirewallDeleteResponse]() {id } DELETE/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id} ##### ModelsExpand Collapse

AttackMitigation {enabled, only\_when\_upstream\_unhealthy } Attack mitigation settings

enabled?: boolean When enabled, automatically mitigate random-prefix attacks to protect upstream DNS servers Link to this property only\_when\_upstream\_unhealthy?: boolean Only mitigate attacks when upstream servers seem unhealthy Link to this property

[Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20attack_mitigation%20%3E%20(schema)>) FirewallIPs = string Cloudflare-assigned DNS IPv4 address [Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20firewall_ips%20%3E%20(schema)>) UpstreamIPs = string Upstream DNS Server IPv4 address [Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20upstream_ips%20%3E%20(schema)>)

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

id: string Identifier. maxLength32 Link to this property deprecate\_any\_requests: boolean Whether to refuse to answer queries for the ANY type Link to this property dns\_firewall\_ips: Array<FirewallIPs> Link to this property ecs\_fallback: boolean Whether to forward client IP (resolver) subnet if no EDNS Client Subnet is sent Link to this property 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 Link to this property 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 Link to this property modified\_on: string Last modification of DNS Firewall cluster formatdate-time Link to this property name: string DNS Firewall cluster name maxLength160 minLength1 Link to this property 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 Link to this property 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 Link to this property retries: number Number of retries for fetching DNS responses from upstream nameservers (not counting the initial attempt) maximum2 minimum0 Link to this property upstream\_ips: Array<UpstreamIPs> minLength1 Link to this property attack\_mitigation?: AttackMitigation {enabled, only\_when\_upstream\_unhealthy } | null Attack mitigation settings Link to this property

[Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20dns_firewall_list_response%20%3E%20(schema)>)

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

[Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20dns_firewall_get_response%20%3E%20(schema)>)

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

[Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20dns_firewall_create_response%20%3E%20(schema)>)

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

[Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20dns_firewall_edit_response%20%3E%20(schema)>)

DNSFirewallDeleteResponse {id }

id?: string Identifier. maxLength32 Link to this property

[Link to this property](<#(resource)%20dns_firewall%20%3E%20(model)%20dns_firewall_delete_response%20%3E%20(schema)>) #### DNS FirewallAnalytics #### DNS FirewallAnalyticsReports ##### [Table](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/subresources/analytics/subresources/reports/methods/get) Deprecated client.dnsFirewall.analytics.reports.get(stringdnsFirewallID, ReportGetParams {account\_id, dimensions, filters, 5 more } params, RequestOptionsoptions?): [Report]() {data, data\_lag, max, 4 more } GET/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id}/dns\_analytics/report #### DNS FirewallAnalyticsReportsBytimes ##### [By Time](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/subresources/analytics/subresources/reports/subresources/bytimes/methods/get) Deprecated client.dnsFirewall.analytics.reports.bytimes.get(stringdnsFirewallID, BytimeGetParams {account\_id, dimensions, filters, 6 more } params, RequestOptionsoptions?): [ByTime]() {data, data\_lag, max, 5 more } GET/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id}/dns\_analytics/report/bytime #### DNS FirewallReverse DNS ##### [Show DNS Firewall Cluster Reverse DNS](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/subresources/reverse_dns/methods/get) client.dnsFirewall.reverseDNS.get(stringdnsFirewallID, ReverseDNSGetParams {account\_id } params, RequestOptionsoptions?): [ReverseDNSGetResponse]() {ptr } GET/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id}/reverse\_dns ##### [Update DNS Firewall Cluster Reverse DNS](https://developers.cloudflare.com/api/typescript/resources/dns_firewall/subresources/reverse_dns/methods/edit) client.dnsFirewall.reverseDNS.edit(stringdnsFirewallID, ReverseDNSEditParams {account\_id, ptr } params, RequestOptionsoptions?): [ReverseDNSEditResponse]() {ptr } PATCH/accounts/{account\_id}/dns\_firewall/{dns\_firewall\_id}/reverse\_dns ##### ModelsExpand Collapse

ReverseDNSGetResponse {ptr }

ptr: Record<string, string> Map of cluster IP addresses to PTR record contents Link to this property

[Link to this property](<#(resource)%20dns_firewall.reverse_dns%20%3E%20(model)%20reverse_dns_get_response%20%3E%20(schema)>)

ReverseDNSEditResponse {ptr }

ptr: Record<string, string> Map of cluster IP addresses to PTR record contents Link to this property

[Link to this property](<#(resource)%20dns_firewall.reverse_dns%20%3E%20(model)%20reverse_dns_edit_response%20%3E%20(schema)>)