--- title: Firewall --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) 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/resources/firewall/subresources/lockdowns/methods/list) GET/zones/{zone\_id}/firewall/lockdowns ##### [Get a Zone Lockdown rule](https://developers.cloudflare.com/api/resources/firewall/subresources/lockdowns/methods/get) GET/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id} ##### [Create a Zone Lockdown rule](https://developers.cloudflare.com/api/resources/firewall/subresources/lockdowns/methods/create) POST/zones/{zone\_id}/firewall/lockdowns ##### [Update a Zone Lockdown rule](https://developers.cloudflare.com/api/resources/firewall/subresources/lockdowns/methods/update) PUT/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id} ##### [Delete a Zone Lockdown rule](https://developers.cloudflare.com/api/resources/firewall/subresources/lockdowns/methods/delete) DELETE/zones/{zone\_id}/firewall/lockdowns/{lock\_downs\_id} ##### ModelsExpand Collapse
Configuration = array of LockdownIPConfiguration { target, value } or LockdownCIDRConfiguration { target, value } 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:
LockdownIPConfiguration object {target, value } target: optional "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 string 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
LockdownCIDRConfiguration object {target, value } target: optional "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 string 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)>)
Lockdown object {id, configurations, created\_on, 4 more } id: string 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: string The timestamp of when the rule was created. formatdate-time Link to this property description: string An informative summary of the rule. maxLength1024 Link to this property modified\_on: string The timestamp of when the rule was last modified. formatdate-time Link to this property paused: boolean When true, indicates that the rule is currently paused. Link to this property urls: array of 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)>)
LockdownCIDRConfiguration object {target, value } target: optional "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 string 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)>)
LockdownIPConfiguration object {target, value } target: optional "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 string 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)>) LockdownURL = string [Link to this property](<#(resource)%20firewall.lockdowns%20%3E%20(model)%20lockdown_url%20%3E%20(schema)>)
LockdownDeleteResponse object {id } id: optional string 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/resources/firewall/subresources/rules/methods/list) Deprecated GET/zones/{zone\_id}/firewall/rules ##### [Get a firewall rule](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/get) Deprecated GET/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Create firewall rules](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/create) Deprecated POST/zones/{zone\_id}/firewall/rules ##### [Update a firewall rule](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/update) Deprecated PUT/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Update priority of a firewall rule](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/edit) Deprecated PATCH/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Delete a firewall rule](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/delete) Deprecated DELETE/zones/{zone\_id}/firewall/rules/{rule\_id} ##### [Update firewall rules](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/bulk_update) Deprecated PUT/zones/{zone\_id}/firewall/rules ##### [Update priority of firewall rules](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/bulk_edit) Deprecated PATCH/zones/{zone\_id}/firewall/rules ##### [Delete firewall rules](https://developers.cloudflare.com/api/resources/firewall/subresources/rules/methods/bulk_delete) Deprecated DELETE/zones/{zone\_id}/firewall/rules ##### ModelsExpand Collapse
DeletedFilter object {id, deleted } id: string The unique identifier of the filter. maxLength32 minLength32 Link to this property deleted: boolean 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)>)
FirewallRule object {id, action, description, 5 more } id: optional string 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 string An informative summary of the firewall rule. maxLength500 Link to this property
filter: optional FirewallFilter { id, description, expression, 2 more } or DeletedFilter { id, deleted } One of the following:
FirewallFilter object {id, description, expression, 2 more } id: optional string The unique identifier of the filter. maxLength32 minLength32 Link to this property description: optional string An informative summary of the filter. maxLength500 Link to this property expression: optional string The filter expression. For more information, refer to Expressions. Link to this property paused: optional boolean When true, indicates that the filter is currently paused. Link to this property ref: optional string A short reference tag. Allows you to select related filters. maxLength50 Link to this property
Link to this property
DeletedFilter object {id, deleted } id: string The unique identifier of the filter. maxLength32 minLength32 Link to this property deleted: boolean When true, indicates that the firewall rule was deleted. Link to this property
Link to this property
Link to this property paused: optional boolean When true, indicates that the firewall rule is currently paused. Link to this property priority: optional 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 Link to this property
products: optional array of 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 string 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)>)
Product = "zoneLockdown"or "uaBlock"or "bic"or 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/resources/firewall/subresources/access_rules/methods/list) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Get an IP Access rule](https://developers.cloudflare.com/api/resources/firewall/subresources/access_rules/methods/get) GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Create an IP Access rule](https://developers.cloudflare.com/api/resources/firewall/subresources/access_rules/methods/create) POST/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules ##### [Update an IP Access rule](https://developers.cloudflare.com/api/resources/firewall/subresources/access_rules/methods/edit) PATCH/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### [Delete an IP Access rule](https://developers.cloudflare.com/api/resources/firewall/subresources/access_rules/methods/delete) DELETE/{accounts\_or\_zones}/{account\_or\_zone\_id}/firewall/access\_rules/rules/{rule\_id} ##### ModelsExpand Collapse
AccessRuleCIDRConfiguration object {target, value } target: optional "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 string 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)>)
AccessRuleIPConfiguration object {target, value } target: optional "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 string 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)>)
ASNConfiguration object {target, value } target: optional "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 string 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)>)
CountryConfiguration object {target, value } target: optional "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 string 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)>)
IPV6Configuration object {target, value } target: optional "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 string 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)>)
AccessRuleListResponse object {id, allowed\_modes, configuration, 5 more } id: string The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: array of "block"or "challenge"or "whitelist"or 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: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 more The rule configuration. One of the following:
AccessRuleIPConfiguration object {target, value } target: optional "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 string 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
IPV6Configuration object {target, value } target: optional "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 string The IPv6 address to match. Link to this property
Link to this property
AccessRuleCIDRConfiguration object {target, value } target: optional "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 string 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
ASNConfiguration object {target, value } target: optional "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 string The AS number to match. Link to this property
Link to this property
CountryConfiguration object {target, value } target: optional "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 string 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: "block"or "challenge"or "whitelist"or 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 string The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: optional string The timestamp of when the rule was last modified. formatdate-time Link to this property notes: optional string An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: optional object {id, email, type } All zones owned by the user will have the rule applied. id: optional string Defines an identifier. maxLength32 Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
type: optional "user"or "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)>)
AccessRuleGetResponse object {id, allowed\_modes, configuration, 5 more } id: string The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: array of "block"or "challenge"or "whitelist"or 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: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 more The rule configuration. One of the following:
AccessRuleIPConfiguration object {target, value } target: optional "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 string 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
IPV6Configuration object {target, value } target: optional "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 string The IPv6 address to match. Link to this property
Link to this property
AccessRuleCIDRConfiguration object {target, value } target: optional "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 string 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
ASNConfiguration object {target, value } target: optional "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 string The AS number to match. Link to this property
Link to this property
CountryConfiguration object {target, value } target: optional "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 string 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: "block"or "challenge"or "whitelist"or 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 string The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: optional string The timestamp of when the rule was last modified. formatdate-time Link to this property notes: optional string An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: optional object {id, email, type } All zones owned by the user will have the rule applied. id: optional string Defines an identifier. maxLength32 Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
type: optional "user"or "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)>)
AccessRuleCreateResponse object {id, allowed\_modes, configuration, 5 more } id: string The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: array of "block"or "challenge"or "whitelist"or 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: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 more The rule configuration. One of the following:
AccessRuleIPConfiguration object {target, value } target: optional "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 string 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
IPV6Configuration object {target, value } target: optional "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 string The IPv6 address to match. Link to this property
Link to this property
AccessRuleCIDRConfiguration object {target, value } target: optional "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 string 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
ASNConfiguration object {target, value } target: optional "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 string The AS number to match. Link to this property
Link to this property
CountryConfiguration object {target, value } target: optional "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 string 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: "block"or "challenge"or "whitelist"or 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 string The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: optional string The timestamp of when the rule was last modified. formatdate-time Link to this property notes: optional string An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: optional object {id, email, type } All zones owned by the user will have the rule applied. id: optional string Defines an identifier. maxLength32 Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
type: optional "user"or "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)>)
AccessRuleEditResponse object {id, allowed\_modes, configuration, 5 more } id: string The unique identifier of the IP Access rule. maxLength32 Link to this property
allowed\_modes: array of "block"or "challenge"or "whitelist"or 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: AccessRuleIPConfiguration { target, value } or IPV6Configuration { target, value } or AccessRuleCIDRConfiguration { target, value } or 2 more The rule configuration. One of the following:
AccessRuleIPConfiguration object {target, value } target: optional "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 string 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
IPV6Configuration object {target, value } target: optional "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 string The IPv6 address to match. Link to this property
Link to this property
AccessRuleCIDRConfiguration object {target, value } target: optional "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 string 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
ASNConfiguration object {target, value } target: optional "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 string The AS number to match. Link to this property
Link to this property
CountryConfiguration object {target, value } target: optional "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 string 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: "block"or "challenge"or "whitelist"or 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 string The timestamp of when the rule was created. formatdate-time Link to this property modified\_on: optional string The timestamp of when the rule was last modified. formatdate-time Link to this property notes: optional string An informative summary of the rule, typically used as a reminder or explanation. Link to this property
scope: optional object {id, email, type } All zones owned by the user will have the rule applied. id: optional string Defines an identifier. maxLength32 Link to this property email: optional string The contact email address of the user. maxLength90 Link to this property
type: optional "user"or "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)>)
AccessRuleDeleteResponse object {id } id: string 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/resources/firewall/subresources/ua_rules/methods/list) GET/zones/{zone\_id}/firewall/ua\_rules ##### [Get a User Agent Blocking rule](https://developers.cloudflare.com/api/resources/firewall/subresources/ua_rules/methods/get) GET/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### [Create a User Agent Blocking rule](https://developers.cloudflare.com/api/resources/firewall/subresources/ua_rules/methods/create) POST/zones/{zone\_id}/firewall/ua\_rules ##### [Update a User Agent Blocking rule](https://developers.cloudflare.com/api/resources/firewall/subresources/ua_rules/methods/update) PUT/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### [Delete a User Agent Blocking rule](https://developers.cloudflare.com/api/resources/firewall/subresources/ua_rules/methods/delete) DELETE/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### ModelsExpand Collapse
UARuleListResponse object {id, configuration, description, 2 more } id: optional string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: optional object {target, value } The configuration object for the current rule. target: optional string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: optional string 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 string An informative summary of the rule. maxLength1024 Link to this property
mode: optional "block"or "challenge"or "js\_challenge"or "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 boolean 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)>)
UARuleGetResponse object {id, configuration, description, 2 more } id: optional string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: optional object {target, value } The configuration object for the current rule. target: optional string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: optional string 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 string An informative summary of the rule. maxLength1024 Link to this property
mode: optional "block"or "challenge"or "js\_challenge"or "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 boolean 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)>)
UARuleCreateResponse object {id, configuration, description, 2 more } id: optional string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: optional object {target, value } The configuration object for the current rule. target: optional string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: optional string 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 string An informative summary of the rule. maxLength1024 Link to this property
mode: optional "block"or "challenge"or "js\_challenge"or "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 boolean 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)>)
UARuleUpdateResponse object {id, configuration, description, 2 more } id: optional string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: optional object {target, value } The configuration object for the current rule. target: optional string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: optional string 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 string An informative summary of the rule. maxLength1024 Link to this property
mode: optional "block"or "challenge"or "js\_challenge"or "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 boolean 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)>)
UARuleDeleteResponse object {id, configuration, description, 2 more } id: optional string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration: optional object {target, value } The configuration object for the current rule. target: optional string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value: optional string 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 string An informative summary of the rule. maxLength1024 Link to this property
mode: optional "block"or "challenge"or "js\_challenge"or "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 boolean 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/resources/firewall/subresources/waf/subresources/overrides/methods/list) Deprecated GET/zones/{zone\_id}/firewall/waf/overrides ##### [Get a WAF override](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/overrides/methods/get) Deprecated GET/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id} ##### [Create a WAF override](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/overrides/methods/create) Deprecated POST/zones/{zone\_id}/firewall/waf/overrides ##### [Update WAF override](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/overrides/methods/update) Deprecated PUT/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id} ##### [Delete a WAF override](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/overrides/methods/delete) Deprecated DELETE/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id} ##### ModelsExpand Collapse OverrideURL = string [Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20override_url%20%3E%20(schema)>)
RewriteAction object {block, challenge, default, 2 more } Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
block: optional "challenge"or "block"or "simulate"or 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 "challenge"or "block"or "simulate"or 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 "challenge"or "block"or "simulate"or 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 "challenge"or "block"or "simulate"or 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 "challenge"or "block"or "simulate"or 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)>)
WAFRule = map\["challenge"or "block"or "simulate"or 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/resources/firewall/subresources/waf/subresources/packages/methods/list) Deprecated GET/zones/{zone\_id}/firewall/waf/packages ##### [Get a WAF package](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/packages/methods/get) Deprecated GET/zones/{zone\_id}/firewall/waf/packages/{package\_id} ##### ModelsExpand Collapse PackageListResponse = unknown [Link to this property](<#(resource)%20firewall.waf.packages%20%3E%20(model)%20package_list_response%20%3E%20(schema)>)
PackageGetResponse = unknownor string One of the following: unknown Link to this property string 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/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/list) Deprecated GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups ##### [Get a WAF rule group](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/get) Deprecated GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups/{group\_id} ##### [Update a WAF rule group](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/edit) Deprecated PATCH/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups/{group\_id} ##### ModelsExpand Collapse
Group object {id, description, mode, 5 more } id: string Defines the unique identifier of the rule group. maxLength32 Link to this property description: string Defines an informative summary of what the rule group does. Link to this property
mode: "on"or "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: string Defines the name of the rule group. Link to this property rules\_count: number Defines the number of rules in the current rule group. Link to this property
allowed\_modes: optional array of "on"or "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 number Defines the number of rules within the group that have been modified from their default configuration. Link to this property package\_id: optional string 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)>)
GroupGetResponse = unknownor string One of the following: unknown Link to this property string Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.groups%20%3E%20(model)%20group_get_response%20%3E%20(schema)>)
GroupEditResponse = unknownor string One of the following: unknown Link to this property string 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/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/list) Deprecated GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules ##### [Get a WAF rule](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/get) Deprecated GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules/{rule\_id} ##### [Update a WAF rule](https://developers.cloudflare.com/api/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/edit) Deprecated PATCH/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules/{rule\_id} ##### ModelsExpand Collapse
AllowedModesAnomaly = "on"or "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)>)
WAFRuleGroup object {id, name } Defines the rule group to which the current WAF rule belongs. id: optional string Defines the unique identifier of the rule group. maxLength32 Link to this property name: optional string 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 = object {id, allowed\_modes, description, 4 more } or object {id, allowed\_modes, default\_mode, 5 more } or object {id, allowed\_modes, description, 4 more } 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:
WAFManagedRulesAnomalyRule object {id, allowed\_modes, description, 4 more } 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: string Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: array of 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: string Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup { id, name } 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: string Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: string Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
WAFManagedRulesTraditionalDenyRule object {id, allowed\_modes, default\_mode, 5 more } 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: string Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: array of "default"or "disable"or "simulate"or 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: "disable"or "simulate"or "block"or "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: string Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup { id, name } Defines the rule group to which the current WAF rule belongs. Link to this property
mode: "default"or "disable"or "simulate"or 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: string Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: string Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
WAFManagedRulesTraditionalAllowRule object {id, allowed\_modes, description, 4 more } 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: string Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: array of "on"or "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: string Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup { id, name } Defines the rule group to which the current WAF rule belongs. Link to this property
mode: "on"or "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: string Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: string 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)>)
RuleGetResponse = unknownor string One of the following: unknown Link to this property string 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 = object {id, allowed\_modes, description, 4 more } or object {id, allowed\_modes, default\_mode, 5 more } or object {id, allowed\_modes, description, 4 more } 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:
WAFManagedRulesAnomalyRule object {id, allowed\_modes, description, 4 more } 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: string Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: array of 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: string Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup { id, name } 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: string Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: string Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
WAFManagedRulesTraditionalDenyRule object {id, allowed\_modes, default\_mode, 5 more } 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: string Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: array of "default"or "disable"or "simulate"or 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: "disable"or "simulate"or "block"or "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: string Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup { id, name } Defines the rule group to which the current WAF rule belongs. Link to this property
mode: "default"or "disable"or "simulate"or 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: string Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: string Defines the order in which the individual WAF rule is executed within its rule group. Link to this property
Link to this property
WAFManagedRulesTraditionalAllowRule object {id, allowed\_modes, description, 4 more } 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: string Defines the unique identifier of the WAF rule. maxLength32 Link to this property
allowed\_modes: array of "on"or "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: string Defines the public description of the WAF rule. Link to this property group: WAFRuleGroup { id, name } Defines the rule group to which the current WAF rule belongs. Link to this property
mode: "on"or "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: string Defines the unique identifier of a WAF package. maxLength32 Link to this property priority: string 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)>)