UpdateRuleRequest

UpdateRuleRequest
UpdateRuleRequest

Request body to edit a Custom Rule's content.

JSON Example
{
    "name": "string",
    "description": "string",
    "matchData": "string",
    "action": "string"
}
string
name
Required  
Constraints: minLength: 1 maxLength: 255

The new name, validated as on create; the character check is skipped when the trimmed name equals the stored one

string
description
Optional
Constraints: maxLength: 2000

Replaces the description with the same limits as on create; absent or null clears it

string
matchData
Required  
Constraints: maxLength: 8192

Replaces the match criteria, validated for the rule's own type, which cannot be changed; at most 8192 characters (INVALID_MATCH_DATA when longer or invalid). For PATH_FILE_CMD, target_path and process_path must be absolute (start with '/') for match_mode PREFIX; each '|' part of a GLOB must start with '/', '', '?' or '{'; a REGEX must be a valid ECMAScript regular expression. With match_mode EXACT or absent, a value is read as the Agent reads it: a regex when it holds a regex metacharacter, else a glob when it holds '' or '?', else an exact path that must be absolute. argv_pattern and arg_pattern must be valid regular expressions when match_mode is REGEX or they hold a regex metacharacter. 'any' and '*' match anything (INVALID_MATCH_DATA otherwise)

action
Required  

Default verdict of a Rule. MFA_REQUIRED is accepted only for ruleType MFA (any other type is refused with 400 INVALID_RULE_ACTION).

  • ALLOW: The operation is permitted
  • BLOCK: The operation is aborted with -EPERM
  • AUDIT: The operation is logged and alerted, and execution is permitted
  • MFA_REQUIRED: Triggers an interactive TOTP challenge through PAM; accepted only for ruleType MFA
Enumeration: ALLOW, BLOCK, AUDIT, MFA_REQUIRED