Cloudflare API | Filters › list

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

Storage & Databases

R2 Data Catalog

Threat Intelligence

Brand Protection

Workers & Pages

Browser Rendering

Durable Objects

Workers For Platforms

Shared

Filters

Filters

Methods

client.filters.list(, ):

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

Parameters

params:

FilterListParams

zone_id: string

(maxLength: 32)

Path param: Defines an identifier.

id?: string

(maxLength: 32, minLength: 32)

Query param: The unique identifier of the filter.

description?: string

Query param: A case-insensitive string to find in the description.

expression?: string

Query param: A case-insensitive string to find in the expression.

page?: number

(minimum: 1)

Query param: Page number of paginated results.

paused?: boolean

Query param: When true, indicates that the filter is currently paused.

per_page?: number

(maximum: 100, minimum: 5)

Query param: Number of filters per page.

ref?: string

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

Returns

id?: string

(maxLength: 32, minLength: 32)

The unique identifier of the filter.

description?: string

(maxLength: 500)

An informative summary of the filter.

expression?: string

The filter expression. For more information, refer to Expressions.

paused?: boolean

When true, indicates that the filter is currently paused.

ref?: string

(maxLength: 50)

A short reference tag. Allows you to select related filters.

Request example

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 firewallFilter of client.filters.list({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
})) {
  console.log(firewallFilter.id);
}

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": [
    {
      "id": "372e67954025e0ba6aaa6d586b9e0b61",
      "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
  }
}

client.filters.get(, , ):

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.

client.filters.create(, ):

<

>

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.

client.filters.update(, , ):

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.

client.filters.delete(, , ):

FilterDeleteResponse

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.

client.filters.bulkUpdate(, ):

<

>

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.

client.filters.bulkDelete(, ):

FilterBulkDeleteResponse

| null

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.

Domain types

FirewallFilter{…}