API Reference

Firewall

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

WAF

WAFOverrides

List WAF overrides

Deprecated

client.Firewall.WAF.Overrides.List(ctx, params) error

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

Get a WAF override

Deprecated

client.Firewall.WAF.Overrides.Get(ctx, overridesID, query) error

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

Create a WAF override

Deprecated

client.Firewall.WAF.Overrides.New(ctx, params) error

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

Update WAF override

Deprecated

client.Firewall.WAF.Overrides.Update(ctx, overridesID, params) error

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

Delete a WAF override

Deprecated

client.Firewall.WAF.Overrides.Delete(ctx, overridesID, body) error

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

ModelsExpand Collapse

type OverrideURL string

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"

const RewriteActionBlockBlock RewriteActionBlock = "block"

const RewriteActionBlockSimulate RewriteActionBlock = "simulate"

const RewriteActionBlockDisable RewriteActionBlock = "disable"

const RewriteActionBlockDefault RewriteActionBlock = "default"

Challenge RewriteActionChallengeOptional

The WAF rule action to apply.

One of the following:

const RewriteActionChallengeChallenge RewriteActionChallenge = "challenge"

const RewriteActionChallengeBlock RewriteActionChallenge = "block"

const RewriteActionChallengeSimulate RewriteActionChallenge = "simulate"

const RewriteActionChallengeDisable RewriteActionChallenge = "disable"

const RewriteActionChallengeDefault RewriteActionChallenge = "default"

Default RewriteActionDefaultOptional

The WAF rule action to apply.

One of the following:

const RewriteActionDefaultChallenge RewriteActionDefault = "challenge"

const RewriteActionDefaultBlock RewriteActionDefault = "block"

const RewriteActionDefaultSimulate RewriteActionDefault = "simulate"

const RewriteActionDefaultDisable RewriteActionDefault = "disable"

const RewriteActionDefaultDefault RewriteActionDefault = "default"

Disable RewriteActionDisableOptional

The WAF rule action to apply.

One of the following:

const RewriteActionDisableChallenge RewriteActionDisable = "challenge"

const RewriteActionDisableBlock RewriteActionDisable = "block"

const RewriteActionDisableSimulate RewriteActionDisable = "simulate"

const RewriteActionDisableDisable RewriteActionDisable = "disable"

const RewriteActionDisableDefault RewriteActionDisable = "default"

Simulate RewriteActionSimulateOptional

The WAF rule action to apply.

One of the following:

const RewriteActionSimulateChallenge RewriteActionSimulate = "challenge"

const RewriteActionSimulateBlock RewriteActionSimulate = "block"

const RewriteActionSimulateSimulate RewriteActionSimulate = "simulate"

const RewriteActionSimulateDisable RewriteActionSimulate = "disable"

const RewriteActionSimulateDefault RewriteActionSimulate = "default"

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"

const WAFRuleItemBlock WAFRuleItem = "block"

const WAFRuleItemSimulate WAFRuleItem = "simulate"

const WAFRuleItemDisable WAFRuleItem = "disable"

const WAFRuleItemDefault WAFRuleItem = "default"

WAFPackages

List WAF packages

Deprecated

client.Firewall.WAF.Packages.List(ctx, params) (*V4PagePaginationArray[WAFPackageListResponse], error)

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

Get a WAF package

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

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

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

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

Description string

Defines an informative summary of what the rule group does.

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"

const GroupModeOff GroupMode = "off"

Name string

Defines the name of the rule group.

RulesCount float64

Defines the number of rules in the current rule group.

AllowedModes []GroupAllowedModeOptional

Defines the available states for the rule group.

One of the following:

const GroupAllowedModeOn GroupAllowedMode = "on"

const GroupAllowedModeOff GroupAllowedMode = "off"

ModifiedRulesCount float64Optional

Defines the number of rules within the group that have been modified from their default configuration.

PackageID stringOptional

Defines the unique identifier of a WAF package.

maxLength32

WAFPackagesRules

List WAF rules

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

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

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"

const AllowedModesAnomalyOff AllowedModesAnomaly = "off"

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

Name stringOptional

Defines the name of the rule group.