API Reference

Firewall

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

UA Rules

List User Agent Blocking rules

GET/zones/{zone_id}/firewall/ua_rules

Get a User Agent Blocking rule

GET/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}

Create a User Agent Blocking rule

POST/zones/{zone_id}/firewall/ua_rules

Update a User Agent Blocking rule

PUT/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}

Delete a User Agent Blocking rule

DELETE/zones/{zone_id}/firewall/ua_rules/{ua_rule_id}

ModelsExpand Collapse

UARuleListResponse { id, configuration, description, 2 more }

id: optional string

The unique identifier of the User Agent Blocking rule.

maxLength32

configuration: optional { 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.

value: optional string

The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value.

description: optional string

An informative summary of the rule.

maxLength1024

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"

"challenge"

"js_challenge"

"managed_challenge"

paused: optional boolean

When true, indicates that the rule is currently paused.

UARuleGetResponse { id, configuration, description, 2 more }

id: optional string

The unique identifier of the User Agent Blocking rule.

maxLength32

configuration: optional { 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.

value: optional string

The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value.

description: optional string

An informative summary of the rule.

maxLength1024

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"

"challenge"

"js_challenge"

"managed_challenge"

paused: optional boolean

When true, indicates that the rule is currently paused.

UARuleCreateResponse { id, configuration, description, 2 more }

id: optional string

The unique identifier of the User Agent Blocking rule.

maxLength32

configuration: optional { 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.

value: optional string

The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value.

description: optional string

An informative summary of the rule.

maxLength1024

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"

"challenge"

"js_challenge"

"managed_challenge"

paused: optional boolean

When true, indicates that the rule is currently paused.

UARuleUpdateResponse { id, configuration, description, 2 more }

id: optional string

The unique identifier of the User Agent Blocking rule.

maxLength32

configuration: optional { 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.

value: optional string

The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value.

description: optional string

An informative summary of the rule.

maxLength1024

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"

"challenge"

"js_challenge"

"managed_challenge"

paused: optional boolean

When true, indicates that the rule is currently paused.

UARuleDeleteResponse { id, configuration, description, 2 more }

id: optional string

The unique identifier of the User Agent Blocking rule.

maxLength32

configuration: optional { 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.

value: optional string

The exact user agent string to match. This value will be compared to the received User-Agent HTTP header value.

description: optional string

An informative summary of the rule.

maxLength1024

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"

"challenge"

"js_challenge"

"managed_challenge"

paused: optional boolean

When true, indicates that the rule is currently paused.