Detection Rules
A detection rule is a query that runs continuously on new logs as they arrive in Scanner. You can create create, read, update, and delete detection rules with the Scanner API.
Create a new detection rule
POST /v1/detection_rule
Create a new detection rule with the specified data.
If the detection rule is active, it will be immediately scheduled for backfill and execution.
Body
tenant_id required
string
Unique identifier for the tenant
name required
string
Name of the detection rule
description required
string
Description of the detection rule
time_range_s required
number
Lookback period (in seconds). Must be minute granuarlity (for example, 60 seconds is valid, but 30 seconds is not).
run_frequency_s required
number
How frequently to run the detection rule (in seconds). Must be minute granularity and <= time_range_s.
enabled required
boolean
Whether the detection rule is enabled
severity required
The severity of the detection
query_text required
string
Query for the detection rule
event_sink_ids required
list of strings
Event sinks to send event alerts to
tags
list of strings
sync_key
string
Sync key, used by automatic detection rule syncers
Example
Response
Returns the newly created detection rule.
List detection rules
GET /v1/detection_rule
List all detection rules for a tenant.
Query parameters
tenant_id required
string
Unique identifier for the tenant
pagination[page_size]
number
Maximum number of results to return in a page. Defaults to 50
pagination[page_token]
string
Cursor for pagination. list_detection_rulesreturns next_page_token to be used for this field. If the field is not specified, paging will start at the beginning of the list.
Example
Response
Returns a list of detection rule summaries and pagination information. The detection rule summary object is the same as the detection rule object, but it does not include event_sink_ids. The pagination information includes the next_page_tokento use as the pagination cursor. next_page_tokenis null if there are no more remaining pages.
Get a detection rule
GET /v1/detection_rule/{id}
Get the detection rule with the given id.
Example
Response
Returns the detection rule.
Update a detection rule
PUT /v1/detection_rule/{id}
Update the detection rule with the given id.
Body
id required
string
Unique identifier for the detection rule
name
string
Update the name of the detection rule
description
string
Update the description of the detection rule
time_range_s
number
Update the lookback period (in seconds) of the detection rule. Must be minute granularity (for example, 60 seconds is valid, but 30 seconds is not).
run_frequency_s
number
Update the how frequently the detection rule is run (in seconds). Must be minute granularity and <= time_range_s.
enabled
boolean
Enable or disable the detection rule
severity
Update the severity of the detection rule
query_text
string
Update the query for the detection rule
tags
list of strings
event_sink_ids
list of strings
Update the event sinks for the detection rule
sync_key
string
Update the sync key for the detection rule
Example
Response
Returns the updated detection rule.
Delete a detection rule
DELETE /v1/detection_rule/{id}
Delete the detection rule with the given id.
Example
Response
Returns the id and tenant_id for the deleted detection rule.
Detection severity
Unknown
Information
Low
Medium
High
Critical
Fatal
Other
The detection severity must be one of these string values, e.g.
Last updated
Was this helpful?