---
title: WAF
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api/go)
[Firewall](https://developers.cloudflare.com/api/go/resources/firewall)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# WAF
#### WAFOverrides
##### [List WAF overrides](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/overrides/methods/list)
Deprecated
client.Firewall.WAF.Overrides.List(ctx, params) error
GET/zones/{zone\_id}/firewall/waf/overrides
##### [Get a WAF override](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/overrides/methods/get)
Deprecated
client.Firewall.WAF.Overrides.Get(ctx, overridesID, query) error
GET/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id}
##### [Create a WAF override](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/overrides/methods/create)
Deprecated
client.Firewall.WAF.Overrides.New(ctx, params) error
POST/zones/{zone\_id}/firewall/waf/overrides
##### [Update WAF override](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/overrides/methods/update)
Deprecated
client.Firewall.WAF.Overrides.Update(ctx, overridesID, params) error
PUT/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id}
##### [Delete a WAF override](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/overrides/methods/delete)
Deprecated
client.Firewall.WAF.Overrides.Delete(ctx, overridesID, body) error
DELETE/zones/{zone\_id}/firewall/waf/overrides/{overrides\_id}
##### ModelsExpand Collapse
type OverrideURL string
[Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20override_url%20%3E%20(schema)>)
type RewriteAction struct{…}
Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
Block RewriteActionBlockOptional
The WAF rule action to apply.
One of the following:
const RewriteActionBlockChallenge RewriteActionBlock = "challenge"
Link to this property
const RewriteActionBlockBlock RewriteActionBlock = "block"
Link to this property
const RewriteActionBlockSimulate RewriteActionBlock = "simulate"
Link to this property
const RewriteActionBlockDisable RewriteActionBlock = "disable"
Link to this property
const RewriteActionBlockDefault RewriteActionBlock = "default"
Link to this property
Link to this property
Challenge RewriteActionChallengeOptional
The WAF rule action to apply.
One of the following:
const RewriteActionChallengeChallenge RewriteActionChallenge = "challenge"
Link to this property
const RewriteActionChallengeBlock RewriteActionChallenge = "block"
Link to this property
const RewriteActionChallengeSimulate RewriteActionChallenge = "simulate"
Link to this property
const RewriteActionChallengeDisable RewriteActionChallenge = "disable"
Link to this property
const RewriteActionChallengeDefault RewriteActionChallenge = "default"
Link to this property
Link to this property
Default RewriteActionDefaultOptional
The WAF rule action to apply.
One of the following:
const RewriteActionDefaultChallenge RewriteActionDefault = "challenge"
Link to this property
const RewriteActionDefaultBlock RewriteActionDefault = "block"
Link to this property
const RewriteActionDefaultSimulate RewriteActionDefault = "simulate"
Link to this property
const RewriteActionDefaultDisable RewriteActionDefault = "disable"
Link to this property
const RewriteActionDefaultDefault RewriteActionDefault = "default"
Link to this property
Link to this property
Disable RewriteActionDisableOptional
The WAF rule action to apply.
One of the following:
const RewriteActionDisableChallenge RewriteActionDisable = "challenge"
Link to this property
const RewriteActionDisableBlock RewriteActionDisable = "block"
Link to this property
const RewriteActionDisableSimulate RewriteActionDisable = "simulate"
Link to this property
const RewriteActionDisableDisable RewriteActionDisable = "disable"
Link to this property
const RewriteActionDisableDefault RewriteActionDisable = "default"
Link to this property
Link to this property
Simulate RewriteActionSimulateOptional
The WAF rule action to apply.
One of the following:
const RewriteActionSimulateChallenge RewriteActionSimulate = "challenge"
Link to this property
const RewriteActionSimulateBlock RewriteActionSimulate = "block"
Link to this property
const RewriteActionSimulateSimulate RewriteActionSimulate = "simulate"
Link to this property
const RewriteActionSimulateDisable RewriteActionSimulate = "disable"
Link to this property
const RewriteActionSimulateDefault RewriteActionSimulate = "default"
Link to this property
Link to this property
[Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20rewrite_action%20%3E%20(schema)>)
type WAFRule map\[string, WAFRuleItem]
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:
const WAFRuleItemChallenge WAFRuleItem = "challenge"
Link to this property
const WAFRuleItemBlock WAFRuleItem = "block"
Link to this property
const WAFRuleItemSimulate WAFRuleItem = "simulate"
Link to this property
const WAFRuleItemDisable WAFRuleItem = "disable"
Link to this property
const WAFRuleItemDefault WAFRuleItem = "default"
Link to this property
[Link to this property](<#(resource)%20firewall.waf.overrides%20%3E%20(model)%20waf_rule%20%3E%20(schema)>)
#### WAFPackages
##### [List WAF packages](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/methods/list)
Deprecated
client.Firewall.WAF.Packages.List(ctx, params) (\*V4PagePaginationArray\[[WAFPackageListResponse]()], error)
GET/zones/{zone\_id}/firewall/waf/packages
##### [Get a WAF package](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/methods/get)
Deprecated
client.Firewall.WAF.Packages.Get(ctx, packageID, query) (\*unknown, error)
GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}
#### WAFPackagesGroups
##### [List WAF rule groups](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/list)
Deprecated
client.Firewall.WAF.Packages.Groups.List(ctx, packageID, params) (\*V4PagePaginationArray\[[Group]()], error)
GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups
##### [Get a WAF rule group](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/get)
Deprecated
client.Firewall.WAF.Packages.Groups.Get(ctx, packageID, groupID, query) (\*unknown, error)
GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups/{group\_id}
##### [Update a WAF rule group](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/subresources/groups/methods/edit)
Deprecated
client.Firewall.WAF.Packages.Groups.Edit(ctx, packageID, groupID, params) (\*unknown, error)
PATCH/zones/{zone\_id}/firewall/waf/packages/{package\_id}/groups/{group\_id}
##### ModelsExpand Collapse
type Group struct{…}
ID string
Defines the unique identifier of the rule group.
maxLength32
Link to this property
Description string
Defines an informative summary of what the rule group does.
Link to this property
Mode GroupMode
Defines the state of the rules contained in the rule group. When on, the rules in the group are configurable/usable.
One of the following:
const GroupModeOn GroupMode = "on"
Link to this property
const GroupModeOff GroupMode = "off"
Link to this property
Link to this property
Name string
Defines the name of the rule group.
Link to this property
RulesCount float64
Defines the number of rules in the current rule group.
Link to this property
AllowedModes \[]GroupAllowedModeOptional
Defines the available states for the rule group.
One of the following:
const GroupAllowedModeOn GroupAllowedMode = "on"
Link to this property
const GroupAllowedModeOff GroupAllowedMode = "off"
Link to this property
Link to this property
ModifiedRulesCount float64Optional
Defines the number of rules within the group that have been modified from their default configuration.
Link to this property
PackageID stringOptional
Defines the unique identifier of a WAF package.
maxLength32
Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.groups%20%3E%20(model)%20group%20%3E%20(schema)>)
#### WAFPackagesRules
##### [List WAF rules](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/list)
Deprecated
client.Firewall.WAF.Packages.Rules.List(ctx, packageID, params) (\*V4PagePaginationArray\[[WAFPackageRuleListResponse]()], error)
GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules
##### [Get a WAF rule](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/get)
Deprecated
client.Firewall.WAF.Packages.Rules.Get(ctx, packageID, ruleID, query) (\*unknown, error)
GET/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules/{rule\_id}
##### [Update a WAF rule](https://developers.cloudflare.com/api/go/resources/firewall/subresources/waf/subresources/packages/subresources/rules/methods/edit)
Deprecated
client.Firewall.WAF.Packages.Rules.Edit(ctx, packageID, ruleID, params) (\*[WAFPackageRuleEditResponse](), error)
PATCH/zones/{zone\_id}/firewall/waf/packages/{package\_id}/rules/{rule\_id}
##### ModelsExpand Collapse
type AllowedModesAnomaly string
Defines the mode anomaly. When set to on, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.
One of the following:
const AllowedModesAnomalyOn AllowedModesAnomaly = "on"
Link to this property
const AllowedModesAnomalyOff AllowedModesAnomaly = "off"
Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20allowed_modes_anomaly%20%3E%20(schema)>)
type WAFRuleGroup struct{…}
Defines the rule group to which the current WAF rule belongs.
ID stringOptional
Defines the unique identifier of the rule group.
maxLength32
Link to this property
Name stringOptional
Defines the name of the rule group.
Link to this property
[Link to this property](<#(resource)%20firewall.waf.packages.rules%20%3E%20(model)%20waf_rule_group%20%3E%20(schema)>)