--- title: Update a User Agent Blocking rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Firewall](https://developers.cloudflare.com/api/python/resources/firewall) [UA Rules](https://developers.cloudflare.com/api/python/resources/firewall/subresources/ua_rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update a User Agent Blocking rule firewall.ua\_rules.update(strua\_rule\_id, UARuleUpdateParams\*\*kwargs) -> [UARuleUpdateResponse]() PUT/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} Updates an existing User Agent Blocking rule. ##### Security
API Token The preferred authorization scheme for interacting with the Cloudflare API. Create a token. **Example:**Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**X-Auth-Email: user@example.com The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
##### Accepted Permissions (at least one required) `Firewall Services Write` ##### ParametersExpand Collapse zone\_id: str Defines an identifier. maxLength32 [Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>) ua\_rule\_id: str The unique identifier of the User Agent Blocking rule. maxLength32 [Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20ua_rule_id%20%3E%20(schema)>)
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](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20configuration%20%3E%20(schema)>)
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](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20mode%20%3E%20(schema)>) description: Optional\[str] An informative summary of the rule. This value is sanitized and any tags will be removed. maxLength1024 [Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20description%20%3E%20(schema)>) paused: Optional\[[bool]()] When true, indicates that the rule is currently paused. [Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20paused%20%3E%20(schema)>) ##### ReturnsExpand Collapse
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)>) ### Update a User Agent Blocking rule Python HTTPTypeScriptPythonGoTerraform ``` import os from cloudflare import Cloudflare client = Cloudflare( api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted ) ua_rule = client.firewall.ua_rules.update( ua_rule_id="372e67954025e0ba6aaa6d586b9e0b59", zone_id="023e105f4ecef8ad9ca31a8372d0c353", configuration={}, mode="challenge", ) print(ua_rule.id) ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b59", "configuration": { "target": "ua", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4" }, "description": "Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack", "mode": "js_challenge", "paused": false }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "372e67954025e0ba6aaa6d586b9e0b59", "configuration": { "target": "ua", "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4" }, "description": "Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack", "mode": "js_challenge", "paused": false }, "success": true } ```