API Reference

Firewall

WAF

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Overrides

List WAF overrides

Deprecated

client.firewall.waf.overrides.list(OverrideListParams { zone_id, page, per_page } params, RequestOptionsoptions?): void

GET/zones/{zone_id}/firewall/waf/overrides

Get a WAF override

Deprecated

client.firewall.waf.overrides.get(stringoverridesID, OverrideGetParams { zone_id } params, RequestOptionsoptions?): void

GET/zones/{zone_id}/firewall/waf/overrides/{overrides_id}

Create a WAF override

Deprecated

client.firewall.waf.overrides.create(OverrideCreateParams { zone_id, urls } params, RequestOptionsoptions?): void

POST/zones/{zone_id}/firewall/waf/overrides

Update WAF override

Deprecated

client.firewall.waf.overrides.update(stringoverridesID, OverrideUpdateParams { zone_id, id, rewrite_action, 2 more } params, RequestOptionsoptions?): void

PUT/zones/{zone_id}/firewall/waf/overrides/{overrides_id}

Delete a WAF override

Deprecated

client.firewall.waf.overrides.delete(stringoverridesID, OverrideDeleteParams { zone_id } params, RequestOptionsoptions?): void

DELETE/zones/{zone_id}/firewall/waf/overrides/{overrides_id}

ModelsExpand Collapse

OverrideURL = string

RewriteAction { block, challenge, default, 2 more }

Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.

block?: "challenge" | "block" | "simulate" | 2 more

The WAF rule action to apply.

One of the following:

"challenge"

"block"

"simulate"

"disable"

"default"

challenge?: "challenge" | "block" | "simulate" | 2 more

The WAF rule action to apply.

One of the following:

"challenge"

"block"

"simulate"

"disable"

"default"

default?: "challenge" | "block" | "simulate" | 2 more

The WAF rule action to apply.

One of the following:

"challenge"

"block"

"simulate"

"disable"

"default"

disable?: "challenge" | "block" | "simulate" | 2 more

The WAF rule action to apply.

One of the following:

"challenge"

"block"

"simulate"

"disable"

"default"

simulate?: "challenge" | "block" | "simulate" | 2 more

The WAF rule action to apply.

One of the following:

"challenge"

"block"

"simulate"

"disable"

"default"

WAFRule = Record<string, "challenge" | "block" | "simulate" | 2 more>

An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a groups object or a rules object.

One of the following:

"challenge"

"block"

"simulate"

"disable"

"default"