Skip to content
Cloudflare API
Start here
API Reference
Firewall

Rules

List firewall rules
Deprecated
firewall.rules.list(RuleListParams**kwargs) -> SyncV4PagePaginationArray[FirewallRule]
GET/zones/{zone_id}/firewall/rules
Get a firewall rule
Deprecated
firewall.rules.get(strrule_id, RuleGetParams**kwargs) -> FirewallRule
GET/zones/{zone_id}/firewall/rules/{rule_id}
Create firewall rules
Deprecated
firewall.rules.create(RuleCreateParams**kwargs) -> SyncSinglePage[FirewallRule]
POST/zones/{zone_id}/firewall/rules
Update a firewall rule
Deprecated
firewall.rules.update(strrule_id, RuleUpdateParams**kwargs) -> FirewallRule
PUT/zones/{zone_id}/firewall/rules/{rule_id}
Update priority of a firewall rule
Deprecated
firewall.rules.edit(strrule_id, RuleEditParams**kwargs) -> SyncSinglePage[FirewallRule]
PATCH/zones/{zone_id}/firewall/rules/{rule_id}
Delete a firewall rule
Deprecated
firewall.rules.delete(strrule_id, RuleDeleteParams**kwargs) -> FirewallRule
DELETE/zones/{zone_id}/firewall/rules/{rule_id}
Update firewall rules
Deprecated
firewall.rules.bulk_update(RuleBulkUpdateParams**kwargs) -> SyncSinglePage[FirewallRule]
PUT/zones/{zone_id}/firewall/rules
Update priority of firewall rules
Deprecated
firewall.rules.bulk_edit(RuleBulkEditParams**kwargs) -> SyncSinglePage[FirewallRule]
PATCH/zones/{zone_id}/firewall/rules
Delete firewall rules
Deprecated
firewall.rules.bulk_delete(RuleBulkDeleteParams**kwargs) -> SyncSinglePage[FirewallRule]
DELETE/zones/{zone_id}/firewall/rules
ModelsExpand Collapse
class DeletedFilter: …
id: str

The unique identifier of the filter.

maxLength32
minLength32
deleted: bool

When true, indicates that the firewall rule was deleted.

class FirewallRule: …
id: Optional[str]

The unique identifier of the firewall rule.

maxLength32
action: Optional[Action]

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

description: Optional[str]

An informative summary of the firewall rule.

maxLength500
filter: Optional[Filter]
One of the following:
class FirewallFilter: …
id: Optional[str]

The unique identifier of the filter.

maxLength32
minLength32
description: Optional[str]

An informative summary of the filter.

maxLength500
expression: Optional[str]

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

paused: Optional[bool]

When true, indicates that the filter is currently paused.

ref: Optional[str]

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

maxLength50
class DeletedFilter: …
id: str

The unique identifier of the filter.

maxLength32
minLength32
deleted: bool

When true, indicates that the firewall rule was deleted.

paused: Optional[bool]

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

priority: Optional[float]

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: Optional[List[Product]]
One of the following:
"zoneLockdown"
"uaBlock"
"bic"
"hot"
"securityLevel"
"rateLimit"
"waf"
ref: Optional[str]

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

maxLength50
Literal["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"