evaluate_events
Evaluate JSON events against Sigma rules to identify matches, using stateless detection for simple rules and stateful correlation for rule collections.
Instructions
Evaluate JSON events against Sigma rules and return matches. Detection-only rules use the stateless engine; collections with correlations use the stateful correlation engine. Rules via inline yaml or path; events via an inline events JSON array or an NDJSON events_path. Optional pipelines and match_detail (off/summary/full).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | Path to a Sigma file or directory. Mutually exclusive with `yaml`. | |
| yaml | No | Inline Sigma YAML. Mutually exclusive with `path`. | |
| events | No | Inline events as a JSON array of objects. Mutually exclusive with `events_path`. | |
| enrichers | No | Inline enrichers config (YAML/JSON) applied to results before returning. Mutually exclusive with `enrichers_path`. `lookup` enrichers are not supported here (no dynamic-source cache); use the daemon for those. | |
| pipelines | No | Processing pipelines (builtin names or file paths). | |
| events_path | No | Path to an NDJSON file of events. Mutually exclusive with `events`. | |
| match_detail | No | Match-detail verbosity: `off` (default), `summary`, or `full`. | |
| enrichers_path | No | Path to an enrichers config file. Mutually exclusive with `enrichers`. | |
| timestamp_fields | No | Extra event field names to try for correlation timestamp extraction. |