PolicyRuleDto

PolicyRuleDto
PolicyRuleDto

A Rule attached to a Policy, in evaluation order.

JSON Example
{
    "policyId": 0,
    "ruleId": 0,
    "ruleName": "string",
    "ruleType": "string",
    "action": "string",
    "ruleRank": "string",
    "isBuiltIn": false,
    "isEnabled": false,
    "description": "string",
    "matchData": "string",
    "revision": 0,
    "updatedAt": "string",
    "sequence": 0
}
integer As int64 As int64
policyId
Required  

Identifier of the Policy the rule is attached to

integer As int64 As int64
ruleId
Required  

Identifier of the attached rule

string
ruleName
Required  

Current name of the attached rule

string
ruleType
Required  

Rule type code of the attached rule: PATH_FILE_CMD, HASH, PUBLISHER_SIGNING, MFA, ANTI_TAMPER or VIB_REPUTATION in this release; further codes are added by new releases; an empty string when the Rule cannot be resolved

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
ruleRank
Required  

Evaluation rank: CUSTOM_LOCAL (custom rules) first, then CUSTOM_GLOBAL (SHA-256 rules created from the file catalog), then VIRTUAL_PATCHING, then DEFAULT_ATTACK. It decides the order rules are sent to the agent, ahead of Policy stack rank and sequence.

  • UNSPECIFIED: Built-in Rules from a Rule Pack whose vendor rank is unset
  • CUSTOM_LOCAL: Custom rules created on the Rules page; the default for a Custom Rule and the highest priority. Rule ids 1 to 999,999
  • CUSTOM_GLOBAL: Custom SHA-256 rules created from the file catalog, evaluated after CUSTOM_LOCAL. Rule ids 1,000,000 to 9,999,999
  • VIRTUAL_PATCHING: Built-in Rules from a Rule Pack, evaluated after CUSTOM_GLOBAL. Rule ids 10,000,000 to 99,999,999
  • DEFAULT_ATTACK: Built-in Rules from a Rule Pack, evaluated last. Rule ids 100,000,000 to 999,999,999
Enumeration: UNSPECIFIED, CUSTOM_LOCAL, CUSTOM_GLOBAL, VIRTUAL_PATCHING, DEFAULT_ATTACK
boolean
isBuiltIn
Required  

True for a Built-in Rule installed from a Rule Pack; its matchData is then not returned

boolean
isEnabled
Required  

Current enabled state of the attached rule (always true for a Built-in Rule). A disabled rule stays attached but is not compiled, so the next Policy publish leaves it out; GET /api/v1/policies/{id}/pending-changes tells whether the published snapshot still carries it

string
description
Optional

Description of the attached rule. Null when it has none

string
matchData
Optional

JSON-encoded rule match criteria. Null for built-in system rules.

integer As int32 As int32
revision
Required  

Current revision of the Rule

string As date-time As date-time
updatedAt
Required  

When the Rule was last modified

integer As int32 As int32
sequence
Required  

Position of the rule within the Policy, starting at 1; the Publish compiler orders a Policy's rules by it and the agent stops at the first match, so it is not cosmetic. Attaching a rule gives it the highest sequence plus 1; reorder and sync renumber from 1 in the order given