--- title: Firewall --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Firewall #### FirewallLockdowns ##### [List Zone Lockdown rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/lockdowns/methods/list) firewall.lockdowns.list(LockdownListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Lockdown]()] GET/zones/{zone\_id}/firewall/lockdowns ##### [Get a Zone Lockdown rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/lockdowns/methods/get) firewall.lockdowns.get(strlock\_downs\_id, LockdownGetParams\*\*kwargs) -> [Lockdown]() GET/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id} ##### [Create a Zone Lockdown rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/lockdowns/methods/create) firewall.lockdowns.create(LockdownCreateParams\*\*kwargs) -> [Lockdown]() POST/zones/{zone\_id}/firewall/lockdowns ##### [Update a Zone Lockdown rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/lockdowns/methods/update) firewall.lockdowns.update(strlock\_downs\_id, LockdownUpdateParams\*\*kwargs) -> [Lockdown]() PUT/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id} ##### [Delete a Zone Lockdown rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/lockdowns/methods/delete) firewall.lockdowns.delete(strlock\_downs\_id, LockdownDeleteParams\*\*kwargs) -> [LockdownDeleteResponse]() DELETE/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id} ##### ModelsExpand Collapse
List\[ConfigurationItem] A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations. One of the following:
class LockdownIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class LockdownCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the Zone Lockdown rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24. Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20configuration%20%3E%20(schema)>)
class Lockdown: … id: str The unique identifier of the Zone Lockdown rule. maxLength32 Link to this property configurations: Configuration A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of ip or ip_range configurations. Link to this property created\_on: datetime The timestamp of when the rule was created. formatdate-time Link to this property description: str An informative summary of the rule. maxLength1024 Link to this property modified\_on: datetime The timestamp of when the rule was last modified. formatdate-time Link to this property paused: bool When true, indicates that the rule is currently paused. Link to this property urls: List\[LockdownURL] The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns. Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown%20%3E%20(schema)>)
class LockdownCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the Zone Lockdown rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24. Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_cidr_configuration%20%3E%20(schema)>)
class LockdownIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the Zone Lockdown rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_ip_configuration%20%3E%20(schema)>) str [Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_url%20%3E%20(schema)>)
class LockdownDeleteResponse: … id: Optional\[str] The unique identifier of the Zone Lockdown rule. maxLength32 Link to this property
[Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_delete_response%20%3E%20(schema)>) #### FirewallRules ##### [List firewall rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/list) Deprecated firewall.rules.list(RuleListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[FirewallRule]()] GET/zones/{zone\_id}/firewall/rules ##### [Get a firewall rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/get) Deprecated firewall.rules.get(strrule\_id, RuleGetParams\*\*kwargs) -> [FirewallRule]() GET/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Create firewall rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/create) Deprecated firewall.rules.create(RuleCreateParams\*\*kwargs) -> SyncSinglePage\[[FirewallRule]()] POST/zones/{zone\_id}/firewall/rules ##### [Update a firewall rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/update) Deprecated firewall.rules.update(strrule\_id, RuleUpdateParams\*\*kwargs) -> [FirewallRule]() PUT/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Update priority of a firewall rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/edit) Deprecated firewall.rules.edit(strrule\_id, RuleEditParams\*\*kwargs) -> SyncSinglePage\[[FirewallRule]()] PATCH/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Delete a firewall rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/delete) Deprecated firewall.rules.delete(strrule\_id, RuleDeleteParams\*\*kwargs) -> [FirewallRule]() DELETE/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Update firewall rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/bulk_update) Deprecated firewall.rules.bulk\_update(RuleBulkUpdateParams\*\*kwargs) -> SyncSinglePage\[[FirewallRule]()] PUT/zones/{zone\_id}/firewall/rules ##### [Update priority of firewall rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/bulk_edit) Deprecated firewall.rules.bulk\_edit(RuleBulkEditParams\*\*kwargs) -> SyncSinglePage\[[FirewallRule]()] PATCH/zones/{zone\_id}/firewall/rules ##### [Delete firewall rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/rules/methods/bulk_delete) 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 Link to this property deleted: bool When true, indicates that the firewall rule was deleted. Link to this property
[Link to this property](<#(resource)%20firewall.rules%20%3E%20(model)%20deleted_filter%20%3E%20(schema)>)
class FirewallRule: … id: Optional\[str] The unique identifier of the firewall rule. maxLength32 Link to this property action: Optional\[Action] The action to apply to a matched request. The log action is only available on an Enterprise plan. Link to this property description: Optional\[str] An informative summary of the firewall rule. maxLength500 Link to this property
filter: Optional\[Filter] One of the following:
class FirewallFilter: … id: Optional\[str] The unique identifier of the filter. maxLength32 minLength32 Link to this property description: Optional\[str] An informative summary of the filter. maxLength500 Link to this property expression: Optional\[str] The filter expression. For more information, refer to Expressions. Link to this property paused: Optional\[bool] When true, indicates that the filter is currently paused. Link to this property ref: Optional\[str] A short reference tag. Allows you to select related filters. maxLength50 Link to this property
Link to this property
class DeletedFilter: … id: str The unique identifier of the filter. maxLength32 minLength32 Link to this property deleted: bool When true, indicates that the firewall rule was deleted. Link to this property
Link to this property
Link to this property paused: Optional\[bool] When true, indicates that the firewall rule is currently paused. Link to this property 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 Link to this property
products: Optional\[List\[Product]] One of the following: "zoneLockdown" Link to this property "uaBlock" Link to this property "bic" Link to this property "hot" Link to this property "securityLevel" Link to this property "rateLimit" Link to this property "waf" Link to this property
Link to this property ref: Optional\[str] A short reference tag. Allows you to select related firewall rules. maxLength50 Link to this property
[Link to this property](<#(resource)%20firewall.rules%20%3E%20(model)%20firewall_rule%20%3E%20(schema)>)
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" Link to this property "uaBlock" Link to this property "bic" Link to this property "hot" Link to this property "securityLevel" Link to this property "rateLimit" Link to this property "waf" Link to this property
[Link to this property](<#(resource)%20firewall.rules%20%3E%20(model)%20product%20%3E%20(schema)>) #### FirewallAccess Rules ##### [List IP Access rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/list) firewall.access\_rules.list(AccessRuleListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[AccessRuleListResponse]()] GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Get an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/get) firewall.access\_rules.get(strrule\_id, AccessRuleGetParams\*\*kwargs) -> [AccessRuleGetResponse]() GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Create an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/create) firewall.access\_rules.create(AccessRuleCreateParams\*\*kwargs) -> [AccessRuleCreateResponse]() POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Update an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/edit) firewall.access\_rules.edit(strrule\_id, AccessRuleEditParams\*\*kwargs) -> [AccessRuleEditResponse]() PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Delete an IP Access rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/access_rules/methods/delete) firewall.access\_rules.delete(strrule\_id, AccessRuleDeleteParams\*\*kwargs) -> [AccessRuleDeleteResponse]() DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### ModelsExpand Collapse
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_cidr_configuration%20%3E%20(schema)>)
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_ip_configuration%20%3E%20(schema)>)
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20asn_configuration%20%3E%20(schema)>)
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20country_configuration%20%3E%20(schema)>)
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20ipv6_configuration%20%3E%20(schema)>)
class AccessRuleListResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_list_response%20%3E%20(schema)>)
class AccessRuleGetResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_get_response%20%3E%20(schema)>)
class AccessRuleCreateResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_create_response%20%3E%20(schema)>)
class AccessRuleEditResponse: … id: str The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["block", "challenge", "whitelist", 2 more]] The available actions that a rule can apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property
configuration: Configuration The rule configuration. One of the following:
class AccessRuleIPConfiguration: … target: Optional\[Literal\["ip"]] The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property value: Optional\[str] The IP address to match. This address will be compared to the IP address of incoming requests. Link to this property
Link to this property
class IPV6Configuration: … target: Optional\[Literal\["ip6"]] The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property value: Optional\[str] The IPv6 address to match. Link to this property
Link to this property
class AccessRuleCIDRConfiguration: … target: Optional\[Literal\["ip\_range"]] The configuration target. You must set the target to ip_range when specifying an IP address range in the rule. Link to this property value: Optional\[str] The IP address range to match. You can only use prefix lengths /16 and /24 for IPv4 ranges, and prefix lengths /32, /48, and /64 for IPv6 ranges. Link to this property
Link to this property
class ASNConfiguration: … target: Optional\[Literal\["asn"]] The configuration target. You must set the target to asn when specifying an Autonomous System Number (ASN) in the rule. Link to this property value: Optional\[str] The AS number to match. Link to this property
Link to this property
class CountryConfiguration: … target: Optional\[Literal\["country"]] The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property value: Optional\[str] The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to IP Access rules: Parameters. Link to this property
Link to this property
Link to this property
mode: Literal\["block", "challenge", "whitelist", 2 more] The action to apply to a matched request. One of the following: "block" Link to this property "challenge" Link to this property "whitelist" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property created\_on: Optional\[datetime] The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: Optional\[datetime] The timestamp of when the rule was last modified. formatdate-time Link to this property notes: Optional\[str] An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: Optional\[Scope] All zones owned by the user will have the rule applied. id: Optional\[str] Defines an identifier. maxLength32 Link to this property email: Optional\[str] The contact email address of the user. maxLength90 Link to this property
type: Optional\[Literal\["user", "organization"]] Defines the scope of the rule. One of the following: "user" Link to this property "organization" Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_edit_response%20%3E%20(schema)>)
class AccessRuleDeleteResponse: … id: str Defines an identifier. maxLength32 Link to this property
[Link to this property](<#(resource)%20firewall.access_rules%20%3E%20(model)%20access_rule_delete_response%20%3E%20(schema)>) #### FirewallUA Rules ##### [List User Agent Blocking rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/ua_rules/methods/list) firewall.ua\_rules.list(UARuleListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[UARuleListResponse]()] GET/zones/{zone\_id}/firewall/ua\_rules ##### [Get a User Agent Blocking rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/ua_rules/methods/get) firewall.ua\_rules.get(strua\_rule\_id, UARuleGetParams\*\*kwargs) -> [UARuleGetResponse]() GET/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### [Create a User Agent Blocking rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/ua_rules/methods/create) firewall.ua\_rules.create(UARuleCreateParams\*\*kwargs) -> [UARuleCreateResponse]() POST/zones/{zone\_id}/firewall/ua\_rules ##### [Update a User Agent Blocking rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/ua_rules/methods/update) firewall.ua\_rules.update(strua\_rule\_id, UARuleUpdateParams\*\*kwargs) -> [UARuleUpdateResponse]() PUT/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### [Delete a User Agent Blocking rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/ua_rules/methods/delete) firewall.ua\_rules.delete(strua\_rule\_id, UARuleDeleteParams\*\*kwargs) -> [UARuleDeleteResponse]() DELETE/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### ModelsExpand Collapse
class UARuleListResponse: … id: Optional\[str] The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: Optional\[Configuration] The configuration object for the current rule. target: Optional\[str] The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: Optional\[str] The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value. Link to this property
Link to this property description: Optional\[str] An informative summary of the rule. maxLength1024 Link to this property
mode: Optional\[Literal\["block", "challenge", "js\_challenge", "managed\_challenge"]] The action to apply to a matched request. maxLength12 One of the following: "block" Link to this property "challenge" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property paused: Optional\[bool] When true, indicates that the rule is currently paused. Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(model)%20ua_rule_list_response%20%3E%20(schema)>)
class UARuleGetResponse: … id: Optional\[str] The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: Optional\[Configuration] The configuration object for the current rule. target: Optional\[str] The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: Optional\[str] The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value. Link to this property
Link to this property description: Optional\[str] An informative summary of the rule. maxLength1024 Link to this property
mode: Optional\[Literal\["block", "challenge", "js\_challenge", "managed\_challenge"]] The action to apply to a matched request. maxLength12 One of the following: "block" Link to this property "challenge" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property paused: Optional\[bool] When true, indicates that the rule is currently paused. Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(model)%20ua_rule_get_response%20%3E%20(schema)>)
class UARuleCreateResponse: … id: Optional\[str] The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: Optional\[Configuration] The configuration object for the current rule. target: Optional\[str] The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: Optional\[str] The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value. Link to this property
Link to this property description: Optional\[str] An informative summary of the rule. maxLength1024 Link to this property
mode: Optional\[Literal\["block", "challenge", "js\_challenge", "managed\_challenge"]] The action to apply to a matched request. maxLength12 One of the following: "block" Link to this property "challenge" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property paused: Optional\[bool] When true, indicates that the rule is currently paused. Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(model)%20ua_rule_create_response%20%3E%20(schema)>)
class UARuleUpdateResponse: … id: Optional\[str] The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: Optional\[Configuration] The configuration object for the current rule. target: Optional\[str] The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: Optional\[str] The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value. Link to this property
Link to this property description: Optional\[str] An informative summary of the rule. maxLength1024 Link to this property
mode: Optional\[Literal\["block", "challenge", "js\_challenge", "managed\_challenge"]] The action to apply to a matched request. maxLength12 One of the following: "block" Link to this property "challenge" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property paused: Optional\[bool] When true, indicates that the rule is currently paused. Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(model)%20ua_rule_update_response%20%3E%20(schema)>)
class UARuleDeleteResponse: … id: Optional\[str] The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: Optional\[Configuration] The configuration object for the current rule. target: Optional\[str] The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: Optional\[str] The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value. Link to this property
Link to this property description: Optional\[str] An informative summary of the rule. maxLength1024 Link to this property
mode: Optional\[Literal\["block", "challenge", "js\_challenge", "managed\_challenge"]] The action to apply to a matched request. maxLength12 One of the following: "block" Link to this property "challenge" Link to this property "js\_challenge" Link to this property "managed\_challenge" Link to this property
Link to this property paused: Optional\[bool] When true, indicates that the rule is currently paused. Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(model)%20ua_rule_delete_response%20%3E%20(schema)>) #### FirewallWAF #### FirewallWAFOverrides ##### [List WAF overrides](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/overrides/methods/list) Deprecated firewall.waf.overrides.list(OverrideListParams\*\*kwargs) GET/zones/{zone\_id}/firewall/waf/overrides ##### [Get a WAF override](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/overrides/methods/get) Deprecated firewall.waf.overrides.get(stroverrides\_id, OverrideGetParams\*\*kwargs) GET/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id} ##### [Create a WAF override](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/overrides/methods/create) Deprecated firewall.waf.overrides.create(OverrideCreateParams\*\*kwargs) POST/zones/{zone\_id}/firewall/waf/overrides ##### [Update WAF override](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/overrides/methods/update) Deprecated firewall.waf.overrides.update(stroverrides\_id, OverrideUpdateParams\*\*kwargs) PUT/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id} ##### [Delete a WAF override](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/overrides/methods/delete) Deprecated firewall.waf.overrides.delete(stroverrides\_id, OverrideDeleteParams\*\*kwargs) DELETE/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id} ##### ModelsExpand Collapse str [Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20override_url%20%3E%20(schema)>)
class RewriteAction: … Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
block: Optional\[Literal\["challenge", "block", "simulate", 2 more]] The WAF rule action to apply. One of the following: "challenge" Link to this property "block" Link to this property "simulate" Link to this property "disable" Link to this property "default" Link to this property
Link to this property
challenge: Optional\[Literal\["challenge", "block", "simulate", 2 more]] The WAF rule action to apply. One of the following: "challenge" Link to this property "block" Link to this property "simulate" Link to this property "disable" Link to this property "default" Link to this property
Link to this property
default: Optional\[Literal\["challenge", "block", "simulate", 2 more]] The WAF rule action to apply. One of the following: "challenge" Link to this property "block" Link to this property "simulate" Link to this property "disable" Link to this property "default" Link to this property
Link to this property
disable: Optional\[Literal\["challenge", "block", "simulate", 2 more]] The WAF rule action to apply. One of the following: "challenge" Link to this property "block" Link to this property "simulate" Link to this property "disable" Link to this property "default" Link to this property
Link to this property
simulate: Optional\[Literal\["challenge", "block", "simulate", 2 more]] The WAF rule action to apply. One of the following: "challenge" Link to this property "block" Link to this property "simulate" Link to this property "disable" Link to this property "default" Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20rewrite_action%20%3E%20(schema)>)
Dict\[str, Literal\["challenge", "block", "simulate", 2 more]] An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a groups object or a rules object. One of the following: "challenge" Link to this property "block" Link to this property "simulate" Link to this property "disable" Link to this property "default" Link to this property
[Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20waf_rule%20%3E%20(schema)>) #### FirewallWAFPackages ##### [List WAF packages](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/methods/list) Deprecated firewall.waf.packages.list(PackageListParams\*\*kwargs) -> SyncV4PagePaginationArray\[object] GET/zones/{zone\_id}/firewall/waf/packages ##### [Get a WAF package](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/methods/get) Deprecated firewall.waf.packages.get(strpackage\_id, PackageGetParams\*\*kwargs) -> [PackageGetResponse]() GET/zones/{zone\_id}/firewall/waf/packages/{package\_id} ##### ModelsExpand Collapse
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages%20%3E%20(model)%20package_get_response%20%3E%20(schema)>) #### FirewallWAFPackagesGroups ##### [List WAF rule groups](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/list) Deprecated firewall.waf.packages.groups.list(strpackage\_id, GroupListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[Group]()] GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups ##### [Get a WAF rule group](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/get) Deprecated firewall.waf.packages.groups.get(strgroup\_id, GroupGetParams\*\*kwargs) -> [GroupGetResponse]() GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups/{group\_id} ##### [Update a WAF rule group](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/edit) Deprecated firewall.waf.packages.groups.edit(strgroup\_id, GroupEditParams\*\*kwargs) -> [GroupEditResponse]() PATCH/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups/{group\_id} ##### ModelsExpand Collapse
class Group: … id: str Defines the unique identifier of the rule group. maxLength32 Link to this property description: Optional\[str] Defines an informative summary of what the rule group does. Link to this property
mode: Literal\["on", "off"] Defines the state of the rules contained in the rule group. When on, the rules in the group are configurable/usable. One of the following: "on" Link to this property "off" Link to this property
Link to this property name: str Defines the name of the rule group. Link to this property rules\_count: float Defines the number of rules in the current rule group. Link to this property
allowed\_modes: Optional\[List\[Literal\["on", "off"]]] Defines the available states for the rule group. One of the following: "on" Link to this property "off" Link to this property
Link to this property modified\_rules\_count: Optional\[float] Defines the number of rules within the group that have been modified from their default configuration. Link to this property package\_id: Optional\[str] Defines the unique identifier of a WAF package. maxLength32 Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.groups%20%3E%20(model)%20group%20%3E%20(schema)>)
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.groups%20%3E%20(model)%20group_get_response%20%3E%20(schema)>)
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.groups%20%3E%20(model)%20group_edit_response%20%3E%20(schema)>) #### FirewallWAFPackagesRules ##### [List WAF rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/list) Deprecated firewall.waf.packages.rules.list(strpackage\_id, RuleListParams\*\*kwargs) -> SyncV4PagePaginationArray\[[RuleListResponse]()] GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules ##### [Get a WAF rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/get) Deprecated firewall.waf.packages.rules.get(strrule\_id, RuleGetParams\*\*kwargs) -> [RuleGetResponse]() GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules/{rule\_id} ##### [Update a WAF rule](https://developers.cloudflare.com/api/python/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/edit) Deprecated firewall.waf.packages.rules.edit(strrule\_id, RuleEditParams\*\*kwargs) -> [RuleEditResponse]() PATCH/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules/{rule\_id} ##### ModelsExpand Collapse
Literal\["on", "off"] Defines the mode anomaly. When set to on, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules. One of the following: "on" Link to this property "off" Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20allowed_modes_anomaly%20%3E%20(schema)>)
class WAFRuleGroup: … Defines the rule group to which the current WAF rule belongs. id: Optional\[str] Defines the unique identifier of the rule group. maxLength32 Link to this property name: Optional\[str] Defines the name of the rule group. Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20waf_rule_group%20%3E%20(schema)>)
RuleListResponse When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the ‘sensitivity’ property of the WAF package. One of the following:
class WAFManagedRulesAnomalyRule: … When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the ‘sensitivity’ property of the WAF package. id: str Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: List\[AllowedModesAnomaly] Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules. One of the following: "on" Link to this property "off" Link to this property
Link to this property description: str Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup Defines the rule group to which the current WAF rule belongs. Link to this property mode: AllowedModesAnomaly Defines the mode anomaly. When set to on, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules. Link to this property package\_id: str Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: str Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
class WAFManagedRulesTraditionalDenyRule: … When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A ‘deny’ rule will immediately respond to the request based on the configured rule action/mode (for example, ‘block’) and no other rules will be processed. id: str Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["default", "disable", "simulate", 2 more]] Defines the list of possible actions of the WAF rule when it is triggered. One of the following: "default" Link to this property "disable" Link to this property "simulate" Link to this property "block" Link to this property "challenge" Link to this property
Link to this property
default\_mode: Literal\["disable", "simulate", "block", "challenge"] Defines the default action/mode of a rule. One of the following: "disable" Link to this property "simulate" Link to this property "block" Link to this property "challenge" Link to this property
Link to this property description: str Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup Defines the rule group to which the current WAF rule belongs. Link to this property
mode: Literal\["default", "disable", "simulate", 2 more] Defines the action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules. One of the following: "default" Link to this property "disable" Link to this property "simulate" Link to this property "block" Link to this property "challenge" Link to this property
Link to this property package\_id: str Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: str Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
class WAFManagedRulesTraditionalAllowRule: … When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An ‘allow’ rule will immediately allow the request and no other rules will be processed. id: str Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["on", "off"]] Defines the available modes for the current WAF rule. One of the following: "on" Link to this property "off" Link to this property
Link to this property description: str Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup Defines the rule group to which the current WAF rule belongs. Link to this property
mode: Literal\["on", "off"] When set to on, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules. One of the following: "on" Link to this property "off" Link to this property
Link to this property package\_id: str Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: str Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20rule_list_response%20%3E%20(schema)>)
Union\[Optional\[str], Optional\[object]] One of the following: Optional\[str] Link to this property Optional\[object] Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20rule_get_response%20%3E%20(schema)>)
RuleEditResponse When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the ‘sensitivity’ property of the WAF package. One of the following:
class WAFManagedRulesAnomalyRule: … When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the ‘sensitivity’ property of the WAF package. id: str Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: List\[AllowedModesAnomaly] Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules. One of the following: "on" Link to this property "off" Link to this property
Link to this property description: str Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup Defines the rule group to which the current WAF rule belongs. Link to this property mode: AllowedModesAnomaly Defines the mode anomaly. When set to on, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules. Link to this property package\_id: str Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: str Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
class WAFManagedRulesTraditionalDenyRule: … When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A ‘deny’ rule will immediately respond to the request based on the configured rule action/mode (for example, ‘block’) and no other rules will be processed. id: str Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["default", "disable", "simulate", 2 more]] Defines the list of possible actions of the WAF rule when it is triggered. One of the following: "default" Link to this property "disable" Link to this property "simulate" Link to this property "block" Link to this property "challenge" Link to this property
Link to this property
default\_mode: Literal\["disable", "simulate", "block", "challenge"] Defines the default action/mode of a rule. One of the following: "disable" Link to this property "simulate" Link to this property "block" Link to this property "challenge" Link to this property
Link to this property description: str Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup Defines the rule group to which the current WAF rule belongs. Link to this property
mode: Literal\["default", "disable", "simulate", 2 more] Defines the action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules. One of the following: "default" Link to this property "disable" Link to this property "simulate" Link to this property "block" Link to this property "challenge" Link to this property
Link to this property package\_id: str Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: str Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
class WAFManagedRulesTraditionalAllowRule: … When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An ‘allow’ rule will immediately allow the request and no other rules will be processed. id: str Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: List\[Literal\["on", "off"]] Defines the available modes for the current WAF rule. One of the following: "on" Link to this property "off" Link to this property
Link to this property description: str Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup Defines the rule group to which the current WAF rule belongs. Link to this property
mode: Literal\["on", "off"] When set to on, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules. One of the following: "on" Link to this property "off" Link to this property
Link to this property package\_id: str Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: str Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20rule_edit_response%20%3E%20(schema)>)