Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ProtectionRule

The protection rule settings. Protection rules can allow, block, or trigger an alert if a request meets the parameters of an applied rule.

Properties

Optional action

action: Action

The action to take when the traffic is detected as malicious. If unspecified, defaults to {@code OFF}.

Optional description

description: undefined | string

The description of the protection rule.

Optional exclusions

Optional key

key: undefined | string

The unique key of the protection rule.

Optional labels

labels: Array<string>

The list of labels for the protection rule.

*Note:** Protection rules with a {@code ResponseBody} label will have no effect unless {@code isResponseInspected} is true.

Optional modSecurityRuleIds

modSecurityRuleIds: Array<string>

The list of the ModSecurity rule IDs that apply to this protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security's documentation.

Optional name

name: undefined | string

The name of the protection rule.

Functions

getDeserializedJsonObj

getJsonObj