AlertRuleDto

AlertRuleDto
AlertRuleDto

Full presentation model for an Alert Rule

JSON Example
{
    "id": "string",
    "alertRuleId": 0,
    "name": "string",
    "trigger": "string",
    "triggerType": "string",
    "triggerValue": "string",
    "scope": "string",
    "groupScopeId": 0,
    "threshold": "string",
    "thresholdCount": 0,
    "thresholdWindow": "string",
    "delivery": "string",
    "deliveryType": "string",
    "recipient": "string",
    "enabled": false,
    "revision": 0,
    "ruleSource": "string",
    "systemKey": "string",
    "createdAt": "string",
    "updatedAt": "string"
}
string
id
Required  

String identifier matching frontend requirements

integer As int64 As int64
alertRuleId
Required  

Unique canonical Alert Rule identifier

string
name
Required  

Human-readable rule name

string
trigger
Required  

Display-friendly trigger label (e.g. Outcome = Enforced (blocked))

triggerType
Required  

Supported architectural trigger classification for Alert Rules

  • OUTCOME: The rule fires on events with a given outcome (ALLOWED, DETECTED_OBSERVE, PREVENTED, TERMINATED or ERROR)
  • EVENT_CLASS: The rule fires on events of a given class (EXEC, FILE, NET, CONFIG, BEHAVIORAL or TAMPER)
  • EVENT_CATEGORY: The rule fires on events of a given category (PROCESS_EXECUTION, FILE, NETWORK or SYSTEM_CALL)
  • LICENSE_EXPIRY: The built-in license expiration rule. It is not event-driven: its alerts are created by the licensing scheduler, the event engine never evaluates it, and a rule cannot be created or retargeted to this type
Enumeration: OUTCOME, EVENT_CLASS, EVENT_CATEGORY, LICENSE_EXPIRY
string
triggerValue
Required  

Canonical trigger value matching schema enums

string
scope
Required  

Display scope label (e.g. All Hypervisors or group name)

integer As int64 As int64
groupScopeId
Optional

Target Security Group identifier (null for fleet-wide)

string
threshold
Required  

Display-friendly threshold expression

integer As int32 As int32
thresholdCount
Required  

Number of events required to breach threshold

thresholdWindow
Required  

Evaluation lookback window for threshold breach detection

  • ANY_OCCURRENCE: No fixed period: a single matching event qualifies. The default of a rule; the engine looks back only a short period derived from its sweep interval, at least 10 seconds
  • ONE_MINUTE: Matching events are counted over a 60-second lookback; a threshold text such as 5 in 1 minute selects it when the stated minutes are below 5
  • FIVE_MINUTES: Matching events are counted over a 300-second lookback; a threshold text selects it when the stated minutes are 5 or more
Enumeration: ANY_OCCURRENCE, ONE_MINUTE, FIVE_MINUTES
string
delivery
Optional

Formatted delivery description. A webhook destination in it is masked for the AUDITOR role, see recipient.

deliveryType
Optional

Outbound delivery channel type

string
recipient
Optional

Delivery destination (email address or webhook URL). The AUDITOR role receives a webhook destination masked to scheme and host (e.g. https://hooks.example.com/…); ADMIN and SECURITY_OPERATOR receive it in full.

boolean
enabled
Required  

Whether the rule is actively evaluated

integer As int32 As int32
revision
Required  

Monotonically increasing semantic revision number

ruleSource
Required  

Rule provenance origin

  • SYSTEM: Built-in rule. It cannot be deleted or renamed and its trigger, threshold and scope cannot change; only the enabled flag and the delivery settings can
  • CUSTOM: Rule created through the API by a user
Enumeration: SYSTEM, CUSTOM
string
systemKey
Optional

Stable system identifier for built-in rules (null for custom rules)

string As date-time As date-time
createdAt
Required  

Creation timestamp

string As date-time As date-time
updatedAt
Required  

Last update timestamp