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 Cloud Networking

Magic Network Monitoring

Network Interconnects

Observability

Security Center

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Schema Validation

Content Scanning

Delete a filter

Update a filter

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Filters

filters

Methods

Delete Filters -> SinglePage<

>

Deprecated

delete/zones/{zone_id}/filters

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Deletes one or more existing filters.

Update Filters -> SinglePage<

>

Deprecated

put/zones/{zone_id}/filters

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Updates one or more existing filters.

Create Filters -> SinglePage<

>

Deprecated

post/zones/{zone_id}/filters

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Creates one or more filters.

Delete A Filter -> Envelope<

>

Deprecated

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

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Deletes an existing filter.

Get A Filter -> Envelope<

>

Deprecated

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

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Fetches the details of a filter.

List Filters -> V4PagePaginationArray<

>

Deprecated

get/zones/{zone_id}/filters

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Fetches filters in a zone. You can filter the results using several optional parameters.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Firewall Services Write Firewall Services Read

path Parameters

zone_id: string

(maxLength: 32)

Defines an identifier.

query Parameters

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, default: 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, default: 25)

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

Defines 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",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "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}

Deprecated

The Filters API is deprecated in favour of using the Ruleset Engine. See https://developers.cloudflare.com/fundamentals/api/reference/deprecations/#firewall-rules-api-and-filters-api for full details.

Updates an existing filter.

Domain types

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