UpdateAlertRuleRequest

UpdateAlertRuleRequest
UpdateAlertRuleRequest

Payload for updating an existing Alert Rule. expectedRevision is always required (optimistic concurrency). All other fields are independently optional for partial update, except that a built-in SYSTEM rule (AlertRuleDto.ruleSource) rejects any name change or any trigger/threshold/scope change with 409 ALERT_RULE_SYSTEM_IMMUTABLE - only enabled and delivery fields may be changed on a SYSTEM rule.

JSON Example
{
    "id": "string",
    "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,
    "expectedRevision": 0
}
string
id
Optional

Rule ID if echoing frontend adapter

string
name
Optional

New name of the Alert Rule; absent or null keeps the current name. Stored trimmed, at most 255 characters, and no other Alert Rule may have the same name. A built-in (SYSTEM) Alert Rule cannot be renamed

string
trigger
Optional

Display trigger string or canonical condition label

triggerType
Optional

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
Optional

Canonical trigger literal

string
scope
Optional

Target scope string (e.g. All Hypervisors, All Groups)

integer As int64 As int64
groupScopeId
Optional

Target Security Group ID (optional, null for fleet-wide)

string
threshold
Optional

Threshold expression (e.g. 'Any occurrence' or '5 in 1 minute')

integer As int32 As int32
thresholdCount
Optional

Threshold count (>= 1)

thresholdWindow
Optional

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 string (e.g. 'Webhook · https://siem.corp.internal/v1/alerts')

deliveryType
Optional

Outbound delivery notification channel

  • EMAIL: Notifications go to an email address, which must be a valid email address; chosen when the recipient contains @ and no channel is given
  • WEBHOOK: Notifications go to an http or https URL with a host that is not a loopback or unspecified address; chosen when the recipient starts with http:// or https:// and no channel is given
Enumeration: EMAIL, WEBHOOK
string
recipient
Optional

Delivery destination (email address or webhook URL)

boolean
enabled
Optional

Whether the rule is enabled

integer As int32 As int32
expectedRevision
Required  

Expected semantic revision for optimistic concurrency guard