--- title: UA Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Firewall](https://developers.cloudflare.com/api/resources/firewall) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # UA 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.

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.

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.

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.

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)>)