---
title: Get a User Agent Blocking rule
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Firewall](https://developers.cloudflare.com/api/resources/firewall)
[UA Rules](https://developers.cloudflare.com/api/resources/firewall/subresources/ua_rules)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Get a User Agent Blocking rule
GET/zones/{zone\_id}/firewall/ua\_rules/{ua\_rule\_id}
Fetches the details of a 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``Firewall Services Read`
##### P ath ParametersExpand Collapse
zone\_id: string
Defines an identifier.
maxLength32
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
ua\_rule\_id: string
The unique identifier of the User Agent Blocking rule.
maxLength32
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20ua_rule_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
result: 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(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
success: true
Defines whether the API call was successful.
[Link to this property](<#(resource)%20firewall.ua_rules%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Get a User Agent Blocking rule
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/firewall/ua_rules/$UA_RULE_ID \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"
```
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
}
```