WafPSMRule

WafPSMRule
WafPSMRule
JSON Example
{
    "description": "string",
    "enable": false,
    "index": 0,
    "match_case": "string",
    "match_elements": [
        {
            "excluded": false,
            "index": 0,
            "match_case": "string",
            "match_op": "string",
            "name": "string",
            "sub_element": "string"
        }
    ],
    "match_value_max_length": 0,
    "match_value_pattern": "string",
    "match_value_string_group_key": "string",
    "match_value_string_group_ref": "string",
    "mode": "string",
    "name": "string",
    "paranoia_level": "string",
    "rule_id": "string"
}
string
description
Optional

Free-text comment about this rule. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

boolean
enable
Optional

Enable or disable this rule. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
index
Required

Rule index, this is used to determine the order of the rules. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
match_case
Optional

The field match_value_pattern regular expression is case sensitive. Enum options - SENSITIVE, INSENSITIVE. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

match_elements
Optional

The match elements, for example ARGS id or ARGS|!ARGS password. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
match_value_max_length
Optional

The maximum allowed length of the match_value. If this is not set, the length will not be checked. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
match_value_pattern
Optional

A regular expression which describes the expected value. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
match_value_string_group_key
Optional

If match_value_string_group_uuid and match_value_string_group_key are set, the referenced regular expression is used as match_value_pattern. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
match_value_string_group_ref
Optional

The UUID of a string group containing key used in match_value_string_group_key. It is a reference to an object of type StringGroup. Field introduced in 20.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
mode
Optional

WAF Rule mode. This can be detection or enforcement. If this is not set, the Policy mode is used. This only takes effect if the policy allows delegation. Enum options - WAF_MODE_DETECTION_ONLY, WAF_MODE_ENFORCEMENT. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
name
Required

Name of the rule. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
paranoia_level
Optional

WAF Ruleset paranoia mode. This is used to select Rules based on the paranoia-level. Enum options - WAF_PARANOIA_LEVEL_LOW, WAF_PARANOIA_LEVEL_MEDIUM, WAF_PARANOIA_LEVEL_HIGH, WAF_PARANOIA_LEVEL_EXTREME. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
rule_id
Required

Id field which is used for log and metric generation. This id must be unique for all rules in this group. Field introduced in 18.2.3. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of