Search + K

Command Palette

Search for a command to run...

Sign In

Update WAF override

Deprecated
PUT /zones/{zone_id}/firewall/waf/overrides/{overrides_id}
Copy endpoint
https://api.cloudflare.com/client/v4

Updates an existing URI-based WAF override.

Note: Applies only to the previous version of WAF managed rules.

Parameters

path Path Parameters

Name Type
overrides_id required
type FirewallOverridesId = string
zone_id required
type FirewallIdentifier = string

Request Body

application/json required
{
id: FirewallIdentifier

Defines an identifier.

type FirewallIdentifier = string
;
rewrite_action: FirewallRewriteAction

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

interface FirewallRewriteAction {
block?: FirewallWafRewriteAction;
challenge?: FirewallWafRewriteAction;
default?: FirewallWafRewriteAction;
disable?: FirewallWafRewriteAction;
simulate?: FirewallWafRewriteAction;
}
;
rules: FirewallRules

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.

interface FirewallRules {
[key: string]: FirewallWafAction;
}
;
urls: FirewallUrls

The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.

type FirewallUrls = string[]
;
}

Responses

200 application/json

Update WAF override response

type FirewallOverrideResponseSingle = type FirewallApiResponseSingle = never & { result: FirewallOverride
interface FirewallOverride {
description?: FirewallComponentsSchemasDescription;
groups?: FirewallGroups;
id?: FirewallOverridesId;
paused?: FirewallPaused;
priority?: FirewallPriority;
rewrite_action?: FirewallRewriteAction;
rules?: FirewallRules;
urls?: FirewallUrls;
}
; }

Client Errors

4XX application/json

Update WAF override response failure

type FirewallOverrideResponseSingle = type FirewallApiResponseSingle = never & { result: FirewallOverride
interface FirewallOverride {
description?: FirewallComponentsSchemasDescription;
groups?: FirewallGroups;
id?: FirewallOverridesId;
paused?: FirewallPaused;
priority?: FirewallPriority;
rewrite_action?: FirewallRewriteAction;
rules?: FirewallRules;
urls?: FirewallUrls;
}
; }
& interface FirewallApiResponseCommonFailure {
errors: FirewallMessages
type FirewallMessages = { code: number;message: string; }[]
;
messages: FirewallMessages
type FirewallMessages = { code: number;message: string; }[]
;
result: null;
success: false;
}