API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Filters

List filters

Deprecated

client.filters.list(FilterListParams { zone_id, id, description, 5 more } params, RequestOptionsoptions?): V4PagePaginationArray<FirewallFilter { id, description, expression, 2 more } >

GET/zones/{zone_id}/filters

Get a filter

Deprecated

client.filters.get(stringfilterId, FilterGetParams { zone_id } params, RequestOptionsoptions?): FirewallFilter { id, description, expression, 2 more }

GET/zones/{zone_id}/filters/{filter_id}

Create filters

Deprecated

client.filters.create(FilterCreateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<FirewallFilter { id, description, expression, 2 more } >

POST/zones/{zone_id}/filters

Update a filter

Deprecated

client.filters.update(stringfilterId, FilterUpdateParams { zone_id, description, expression, 2 more } params, RequestOptionsoptions?): FirewallFilter { id, description, expression, 2 more }

PUT/zones/{zone_id}/filters/{filter_id}

Delete a filter

Deprecated

client.filters.delete(stringfilterId, FilterDeleteParams { zone_id } params, RequestOptionsoptions?): FilterDeleteResponse { id }

DELETE/zones/{zone_id}/filters/{filter_id}

Update filters

Deprecated

client.filters.bulkUpdate(FilterBulkUpdateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<FirewallFilter { id, description, expression, 2 more } >

PUT/zones/{zone_id}/filters

Delete filters

Deprecated

client.filters.bulkDelete(FilterBulkDeleteParams { zone_id, id } params, RequestOptionsoptions?): FilterBulkDeleteResponse | null

DELETE/zones/{zone_id}/filters

ModelsExpand Collapse

FirewallFilter { id, description, expression, 2 more }

id?: string

The unique identifier of the filter.

maxLength32

minLength32

description?: string

An informative summary of the filter.

maxLength500

expression?: string

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

paused?: boolean

When true, indicates that the filter is currently paused.

ref?: string

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

maxLength50

FilterDeleteResponse { id }

id: string

The unique identifier of the filter.

maxLength32

minLength32

FilterBulkDeleteResponse = Array<FilterBulkDeleteResponseItem> | null

id?: string

The unique identifier of the filter.

maxLength32

minLength32