API Reference

Firewall

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Rules

List firewall rules

Deprecated

client.firewall.rules.list(RuleListParams { zone_id, id, action, 4 more } params, RequestOptionsoptions?): V4PagePaginationArray<FirewallRule { id, action, description, 5 more } >

GET/zones/{zone_id}/firewall/rules

Get a firewall rule

Deprecated

client.firewall.rules.get(stringruleId, RuleGetParams { zone_id } params, RequestOptionsoptions?): FirewallRule { id, action, description, 5 more }

GET/zones/{zone_id}/firewall/rules/{rule_id}

Create firewall rules

Deprecated

client.firewall.rules.create(RuleCreateParams { zone_id, action, filter } params, RequestOptionsoptions?): SinglePage<FirewallRule { id, action, description, 5 more } >

POST/zones/{zone_id}/firewall/rules

Update a firewall rule

Deprecated

client.firewall.rules.update(stringruleId, RuleUpdateParams { zone_id, action, filter } params, RequestOptionsoptions?): FirewallRule { id, action, description, 5 more }

PUT/zones/{zone_id}/firewall/rules/{rule_id}

Update priority of a firewall rule

Deprecated

client.firewall.rules.edit(stringruleId, RuleEditParams { zone_id } params, RequestOptionsoptions?): SinglePage<FirewallRule { id, action, description, 5 more } >

PATCH/zones/{zone_id}/firewall/rules/{rule_id}

Delete a firewall rule

Deprecated

client.firewall.rules.delete(stringruleId, RuleDeleteParams { zone_id } params, RequestOptionsoptions?): FirewallRule { id, action, description, 5 more }

DELETE/zones/{zone_id}/firewall/rules/{rule_id}

Update firewall rules

Deprecated

client.firewall.rules.bulkUpdate(RuleBulkUpdateParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<FirewallRule { id, action, description, 5 more } >

PUT/zones/{zone_id}/firewall/rules

Update priority of firewall rules

Deprecated

client.firewall.rules.bulkEdit(RuleBulkEditParams { zone_id, body } params, RequestOptionsoptions?): SinglePage<FirewallRule { id, action, description, 5 more } >

PATCH/zones/{zone_id}/firewall/rules

Delete firewall rules

Deprecated

client.firewall.rules.bulkDelete(RuleBulkDeleteParams { zone_id } params, RequestOptionsoptions?): SinglePage<FirewallRule { id, action, description, 5 more } >

DELETE/zones/{zone_id}/firewall/rules

ModelsExpand Collapse

DeletedFilter { id, deleted }

id: string

The unique identifier of the filter.

maxLength32

minLength32

deleted: boolean

When true, indicates that the firewall rule was deleted.

FirewallRule { id, action, description, 5 more }

id?: string

The unique identifier of the firewall rule.

maxLength32

action?: Action

The action to apply to a matched request. The log action is only available on an Enterprise plan.

description?: string

An informative summary of the firewall rule.

maxLength500

filter?: FirewallFilter { id, description, expression, 2 more } | DeletedFilter { id, deleted }

One of the following:

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

DeletedFilter { id, deleted }

id: string

The unique identifier of the filter.

maxLength32

minLength32

deleted: boolean

When true, indicates that the firewall rule was deleted.

paused?: boolean

When true, indicates that the firewall rule is currently paused.

priority?: number

The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.

maximum2147483647

minimum0

products?: Array<Product>

One of the following:

"zoneLockdown"

"uaBlock"

"bic"

"hot"

"securityLevel"

"rateLimit"

"waf"

ref?: string

A short reference tag. Allows you to select related firewall rules.

maxLength50

Product = "zoneLockdown" | "uaBlock" | "bic" | 4 more

A list of products to bypass for a request when using the bypass action.

One of the following:

"zoneLockdown"

"uaBlock"

"bic"

"hot"

"securityLevel"

"rateLimit"

"waf"