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

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

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

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

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

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

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.

value?: string

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

description?: string

An informative summary of the rule.

maxLength1024

mode?: "block" | "challenge" | "js_challenge" | "managed_challenge"

The action to apply to a matched request.

maxLength12

One of the following:

"block"

"challenge"

"js_challenge"

"managed_challenge"

paused?: boolean

When true, indicates that the rule is currently paused.

UARuleGetResponse { id, configuration, description, 2 more }

id?: string

The unique identifier of the User Agent Blocking rule.

maxLength32

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.

value?: string

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

description?: string

An informative summary of the rule.

maxLength1024

mode?: "block" | "challenge" | "js_challenge" | "managed_challenge"

The action to apply to a matched request.

maxLength12

One of the following:

"block"

"challenge"

"js_challenge"

"managed_challenge"

paused?: boolean

When true, indicates that the rule is currently paused.

UARuleCreateResponse { id, configuration, description, 2 more }

id?: string

The unique identifier of the User Agent Blocking rule.

maxLength32

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.

value?: string

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

description?: string

An informative summary of the rule.

maxLength1024

mode?: "block" | "challenge" | "js_challenge" | "managed_challenge"

The action to apply to a matched request.

maxLength12

One of the following:

"block"

"challenge"

"js_challenge"

"managed_challenge"

paused?: boolean

When true, indicates that the rule is currently paused.

UARuleUpdateResponse { id, configuration, description, 2 more }

id?: string

The unique identifier of the User Agent Blocking rule.

maxLength32

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.

value?: string

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

description?: string

An informative summary of the rule.

maxLength1024

mode?: "block" | "challenge" | "js_challenge" | "managed_challenge"

The action to apply to a matched request.

maxLength12

One of the following:

"block"

"challenge"

"js_challenge"

"managed_challenge"

paused?: boolean

When true, indicates that the rule is currently paused.

UARuleDeleteResponse { id, configuration, description, 2 more }

id?: string

The unique identifier of the User Agent Blocking rule.

maxLength32

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.

value?: string

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

description?: string

An informative summary of the rule.

maxLength1024

mode?: "block" | "challenge" | "js_challenge" | "managed_challenge"

The action to apply to a matched request.

maxLength12

One of the following:

"block"

"challenge"

"js_challenge"

"managed_challenge"

paused?: boolean

When true, indicates that the rule is currently paused.