create_correlation_rule
Define correlation detection rules using normalized field matching and optional threshold-based correlation to trigger security alerts.
Instructions
Create a new correlation (detection) rule.
definition: the matching expression (the rule's where). Use ONLY normalized
fields, e.g. equals("log.eventCode", 4720),
equals("log.eventCode","4104") && contains("log.eventDataScriptBlockText","mimikatz").
Functions: equals, oneOf, contains, startsWith, endsWith, regexMatch, exists, &&, ||, !.
data_type: 'wineventlog' (id 1) or 'linux' (id 26).
after_events: optional threshold correlation, list of SearchRequest objects with
{indexPattern, with:[{field,operator,value}], within:"now-5m", count:N}.
server: which configured server to target (default active/default).
NOTE: a newly created rule takes ~5 minutes to load into the correlation engine before it will fire. Trigger the matching event after that delay.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| active | No | ||
| server | No | ||
| category | No | Execution | |
| group_by | No | ||
| adversary | No | origin | |
| data_type | No | wineventlog | |
| integrity | No | ||
| technique | No | ||
| definition | Yes | ||
| references | No | ||
| description | No | ||
| after_events | No | ||
| availability | No | ||
| confidentiality | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |