Cloudflare API | Filters › List Filters

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

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Network Interconnects

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Delete a filter

Update a filter

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Security Center

Filters

filters

Methods

Delete Filters -> Envelope<Array<

>>

Deprecated

delete/zones/{zone_id}/filters

Deletes one or more existing filters.

Update Filters -> Envelope<Array<

>>

Deprecated

put/zones/{zone_id}/filters

Updates one or more existing filters.

Create Filters -> Envelope<Array<

>>

Deprecated

post/zones/{zone_id}/filters

Creates one or more filters.

Delete A Filter -> Envelope<

>

Deprecated

delete/zones/{zone_id}/filters/{filter_id}

Deletes an existing filter.

Get A Filter -> Envelope<

>

Deprecated

get/zones/{zone_id}/filters/{filter_id}

Fetches the details of a filter.

List Filters -> V4PagePaginationArray<

>

Deprecated

get/zones/{zone_id}/filters

Fetches filters in a zone. You can filter the results using several optional 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

Accepted Permissions (at least one required)

Firewall Services Write Firewall Services Read

Parameters

zone_id: string

(maxLength: 32)

Identifier

id: string

Optional

(maxLength: 32, minLength: 32)

The unique identifier of the filter.

description: string

Optional

A case-insensitive string to find in the description.

expression: string

Optional

A case-insensitive string to find in the expression.

page: number

Optional

(minimum: 1)

Page number of paginated results.

paused: boolean

Optional

When true, indicates that the filter is currently paused.

per_page: number

Optional

(maximum: 100, minimum: 5)

Number of filters per page.

ref: string

Optional

The filter ref (a short reference tag) to search for. Must be an exact match.

Response fields

errors: Array<

>

messages: Array<

>

result: Array<

>

success: true

Whether the API call was successful

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/filters \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "description": "Restrict access from these browsers on this address range.",
      "expression": "(http.request.uri.path ~ \".*wp-login.php\" or http.request.uri.path ~ \".*xmlrpc.php\") and ip.addr ne 172.16.22.155",
      "paused": false,
      "ref": "FIL-100"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Update A Filter -> Envelope<

>

Deprecated

put/zones/{zone_id}/filters/{filter_id}

Updates an existing filter.

Domain types

FirewallFilter = { id, description, expression, 2 more... }