Cloudflare API | DNS Firewall › Analytics › Reports › Table

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Create DNS Firewall Cluster

Delete DNS Firewall Cluster

Update DNS Firewall Cluster

DNS Firewall Cluster Details

List DNS Firewall Clusters

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

DNS Firewall

dns_firewall

Methods

Create DNS Firewall Cluster -> Envelope<{ id, deprecate_any_requests, dns_firewall_ips, 10 more... }>

post/accounts/{account_id}/dns_firewall

Create a DNS Firewall cluster

Delete DNS Firewall Cluster -> Envelope<{ id }>

delete/accounts/{account_id}/dns_firewall/{dns_firewall_id}

Delete a DNS Firewall cluster

Update DNS Firewall Cluster -> Envelope<{ id, deprecate_any_requests, dns_firewall_ips, 10 more... }>

patch/accounts/{account_id}/dns_firewall/{dns_firewall_id}

Modify the configuration of a DNS Firewall cluster

DNS Firewall Cluster Details -> Envelope<{ 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

List DNS Firewall Clusters -> V4PagePaginationArray<{ id, deprecate_any_requests, dns_firewall_ips, 10 more... }>

get/accounts/{account_id}/dns_firewall

List DNS Firewall clusters for an account

Domain types

AttackMitigation = { enabled, only_when_upstream_unhealthy }

FirewallIPs = string

UpstreamIPs = string

Analytics

dns_firewall.analytics

DNS Firewall Analytics

Reports

dns_firewall.analytics.reports

Methods

Table -> Envelope<

>

get/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report

Retrieves a list of summarised aggregate metrics over a given time period.

See Analytics API properties for detailed information about the available query parameters.

Security

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

Parameters

account_id: string

Identifier

dns_firewall_id: string

Identifier

dimensions: string

Optional

A comma-separated list of dimensions to group results by.

filters: string

Optional

Segmentation filter in 'attribute operator value' format.

limit: number

Optional

Limit number of returned metrics.

metrics: string

Optional

A comma-separated list of metrics to query.

since: string

Optional

Start date and time of requesting data period in ISO 8601 format.

sort: string

Optional

A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).

until: string

Optional

End date and time of requesting data period in ISO 8601 format.

Response fields

errors: Array<

>

messages: Array<

>

success: true

Whether the API call was successful

result:

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/dns_firewall/$DNS_FIREWALL_ID/dns_analytics/report \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": {
    "data": [
      {
        "dimensions": [
          "NODATA"
        ],
        "metrics": [
          0
        ]
      }
    ],
    "data_lag": 60,
    "max": {},
    "min": {},
    "query": {
      "dimensions": [
        "responseCode",
        "queryName"
      ],
      "limit": 100,
      "metrics": [
        "queryCount",
        "responseTimeAvg"
      ],
      "since": "2023-11-11T12:00:00Z",
      "until": "2023-11-11T13:00:00Z",
      "filters": "responseCode==NOERROR,queryType==A",
      "sort": [
        "+responseCode",
        "-queryName"
      ]
    },
    "rows": 100,
    "totals": {}
  }
}

DNS Firewall Analytics Reports

Bytimes

dns_firewall.analytics.reports.bytimes

Methods

By Time -> Envelope<

>

get/accounts/{account_id}/dns_firewall/{dns_firewall_id}/dns_analytics/report/bytime

Retrieves a list of aggregate metrics grouped by time interval.

See Analytics API properties for detailed information about the available query parameters.

Reverse DNS

dns_firewall.reverse_dns

Methods

Update DNS Firewall Cluster Reverse DNS -> Envelope<{ ptr }>

patch/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns

Update reverse DNS configuration (PTR records) for a DNS Firewall cluster

Show DNS Firewall Cluster Reverse DNS -> Envelope<{ ptr }>

get/accounts/{account_id}/dns_firewall/{dns_firewall_id}/reverse_dns

Show reverse DNS configuration (PTR records) for a DNS Firewall cluster