--- title: Update a User Agent Blocking rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Firewall](https://developers.cloudflare.com/api/go/resources/firewall) [UA Rules](https://developers.cloudflare.com/api/go/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 client.Firewall.UARules.Update(ctx, uaRuleID, params) (\*[UARuleUpdateResponse](), error) 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 uaRuleID string 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)>)
params UARuleUpdateParams ZoneID param.Field\[string] Path param: Defines an identifier. maxLength32 Link to this property
Configuration param.Field\[UARuleUpdateParamsConfiguration] Body param: The rule configuration.
type AccessRuleIPConfiguration struct{…} Target AccessRuleIPConfigurationTargetOptional The configuration target. You must set the target to ip when specifying an IP address in the rule. Link to this property Value stringOptional 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
type IPV6Configuration struct{…} Target IPV6ConfigurationTargetOptional The configuration target. You must set the target to ip6 when specifying an IPv6 address in the rule. Link to this property Value stringOptional The IPv6 address to match. Link to this property
Link to this property
type AccessRuleCIDRConfiguration struct{…} Target AccessRuleCIDRConfigurationTargetOptional 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 stringOptional 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
type ASNConfiguration struct{…} Target ASNConfigurationTargetOptional 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 stringOptional The AS number to match. Link to this property
Link to this property
type CountryConfiguration struct{…} Target CountryConfigurationTargetOptional The configuration target. You must set the target to country when specifying a country code in the rule. Link to this property Value stringOptional 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 param.Field\[UARuleUpdateParamsMode] Body param: The action to apply to a matched request. const UARuleUpdateParamsModeBlock UARuleUpdateParamsMode = "block" Link to this property const UARuleUpdateParamsModeChallenge UARuleUpdateParamsMode = "challenge" Link to this property const UARuleUpdateParamsModeWhitelist UARuleUpdateParamsMode = "whitelist" Link to this property const UARuleUpdateParamsModeJSChallenge UARuleUpdateParamsMode = "js\_challenge" Link to this property const UARuleUpdateParamsModeManagedChallenge UARuleUpdateParamsMode = "managed\_challenge" Link to this property
Link to this property Description param.Field\[string]Optional Body param: An informative summary of the rule. This value is sanitized and any tags will be removed. maxLength1024 Link to this property Paused param.Field\[bool]Optional Body param: When true, indicates that the rule is currently paused. Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse
type UARuleUpdateResponse struct{…} ID stringOptional The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
Configuration UARuleUpdateResponseConfigurationOptional The configuration object for the current rule. Target stringOptional The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property Value stringOptional 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 stringOptional An informative summary of the rule. maxLength1024 Link to this property
Mode UARuleUpdateResponseModeOptional The action to apply to a matched request. maxLength12 One of the following: const UARuleUpdateResponseModeBlock UARuleUpdateResponseMode = "block" Link to this property const UARuleUpdateResponseModeChallenge UARuleUpdateResponseMode = "challenge" Link to this property const UARuleUpdateResponseModeJSChallenge UARuleUpdateResponseMode = "js\_challenge" Link to this property const UARuleUpdateResponseModeManagedChallenge UARuleUpdateResponseMode = "managed\_challenge" Link to this property
Link to this property Paused boolOptional 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)%20UARuleUpdateResponse%20%3E%20(schema)>) ### Update a User Agent Blocking rule Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/firewall" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"), ) uaRule, err := client.Firewall.UARules.Update( context.TODO(), "372e67954025e0ba6aaa6d586b9e0b59", firewall.UARuleUpdateParams{ ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"), Configuration: cloudflare.F[firewall.UARuleUpdateParamsConfigurationUnion](firewall.AccessRuleIPConfigurationParam{ }), Mode: cloudflare.F(firewall.UARuleUpdateParamsModeChallenge), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", uaRule.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 } ```