--- title: UA Rules --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Firewall](https://developers.cloudflare.com/api/typescript/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/typescript/resources/firewall/subresources/ua_rules/methods/list) client.firewall.uaRules.list(UARuleListParams {zone\_id, description, page, 3 more } params, RequestOptionsoptions?): V4PagePaginationArray< [UARuleListResponse]() {id, configuration, description, 2 more } > GET/zones/{zone\_id}/firewall/ua\_rules ##### [Get a User Agent Blocking rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/ua_rules/methods/get) client.firewall.uaRules.get(stringuaRuleID, UARuleGetParams {zone\_id } params, RequestOptionsoptions?): [UARuleGetResponse]() {id, configuration, description, 2 more } GET/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### [Create a User Agent Blocking rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/ua_rules/methods/create) client.firewall.uaRules.create(UARuleCreateParams {zone\_id, configuration, mode, 2 more } params, RequestOptionsoptions?): [UARuleCreateResponse]() {id, configuration, description, 2 more } POST/zones/{zone\_id}/firewall/ua\_rules ##### [Update a User Agent Blocking rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/ua_rules/methods/update) client.firewall.uaRules.update(stringuaRuleID, UARuleUpdateParams {zone\_id, configuration, mode, 2 more } params, RequestOptionsoptions?): [UARuleUpdateResponse]() {id, configuration, description, 2 more } PUT/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### [Delete a User Agent Blocking rule](https://developers.cloudflare.com/api/typescript/resources/firewall/subresources/ua_rules/methods/delete) client.firewall.uaRules.delete(stringuaRuleID, UARuleDeleteParams {zone\_id } params, RequestOptionsoptions?): [UARuleDeleteResponse]() {id, configuration, description, 2 more } DELETE/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id} ##### ModelsExpand Collapse
UARuleListResponse {id, configuration, description, 2 more } id?: string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration?: Configuration {target, value } The configuration object for the current rule. target?: string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value?: 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?: string An informative summary of the rule. maxLength1024 Link to this property
mode?: "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?: 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 {id, configuration, description, 2 more } id?: string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration?: Configuration {target, value } The configuration object for the current rule. target?: string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value?: 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?: string An informative summary of the rule. maxLength1024 Link to this property
mode?: "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?: 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 {id, configuration, description, 2 more } id?: string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration?: Configuration {target, value } The configuration object for the current rule. target?: string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value?: 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?: string An informative summary of the rule. maxLength1024 Link to this property
mode?: "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?: 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 {id, configuration, description, 2 more } id?: string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration?: Configuration {target, value } The configuration object for the current rule. target?: string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value?: 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?: string An informative summary of the rule. maxLength1024 Link to this property
mode?: "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?: 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 {id, configuration, description, 2 more } id?: string The unique identifier of the User Agent Blocking rule. maxLength32 Link to this property
configuration?: Configuration {target, value } The configuration object for the current rule. target?: string The configuration target for this rule. You must set the target to ua for User Agent Blocking rules. Link to this property value?: 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?: string An informative summary of the rule. maxLength1024 Link to this property
mode?: "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?: 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)>)