--- title: UA Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Firewall](https://developers.cloudflare.com/api/python/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/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)>)