CreateAlertRuleRequest
Payload for creating a new Alert Rule. name is always required. A trigger condition is also required, but is conditionally satisfiable two ways - trigger (a free-form display string, parsed server-side), OR both triggerType AND triggerValue together (canonical structured form). OpenAPI cannot express this either/or as a required list; omitting all three yields 400 ALERT_RULE_CONDITION_REQUIRED.
{
"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
}
Name of the new Alert Rule. Required; stored trimmed, at most 255 characters, and no other Alert Rule may have the same name
Display trigger string or canonical condition label
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
Canonical trigger literal
Target scope string (e.g. All Hypervisors, All Groups)
Target Security Group ID (optional, null for fleet-wide)
Threshold expression (e.g. 'Any occurrence' or '5 in 1 minute')
Threshold count (>= 1)
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 secondsONE_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 5FIVE_MINUTES: Matching events are counted over a 300-second lookback; a threshold text selects it when the stated minutes are 5 or more
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 givenWEBHOOK: 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
Delivery destination (email address or webhook URL)
Whether the rule is enabled initially