Expand description
Detection alerts: the signals search, status, tags, and assignees routes.
Alert identity is the document _id. Every mutation here takes explicit
ids or an explicit query; there is no reconciliation path (triage spec
section 2).
Structs§
- Alert
Hit - Alert
Page - Signals
Outcome - The raw update-by-query envelope the status, tags, and assignees routes answer with (measured, triage spec section 10).
Enums§
- Alert
Status - The modern status vocabulary. The route also accepts
in-progress, the pre-8.0 nameacknowledgedreplaced; elasticctl never sends it. - Conflicts
- Version-conflict handling for query-scoped transitions.
Abortis the server default: a document whose version moved between resolution and write stops the run rather than being silently skipped.
Constants§
Functions§
- decode_
outcome - Fail-closed decode: all four counters and the
failuresarray are required. A response missing one is anhttperror, never “nothing happened” (main spec section 6.3). - decode_
page - Decode a signals-search response. Fail-closed:
hits.hitsmust be an array and every hit must carry a string_id— an alert without identity cannot be acted on — and an object_source. - search
- Run one bounded signals search with the caller’s body verbatim.
- search_
all - Page a query fully with
sort+search_afterthrough the same route.sortmust be a total order (the caller ends it with a tiebreaker field). - search_
all_ with_ page_ size - The paging loop with an explicit page size, exposed for tests.
- set_
assignees - Add and remove assignee profile uids on explicit alerts in one request. The route rejects a uid present in both lists; callers pre-check.
- set_
tags - Add and remove workflow tags on explicit alerts in one request.
- status_
by_ ids - Transition explicit alerts. The route is idempotent: a no-op transition counts as processed.
- status_
by_ query - Transition every alert a query matches. The server resolves the set and mutates it in one update-by-query — no client-side id round-trip.