Create a detection rule
Create a new detection rule.
When used with API key authentication, the user's key gets assigned to the affected rules. If the user's key gets deleted or the user becomes inactive, the rules will stop running.
If the API key that is used for authorization has different privileges than the key that created or most recently updated the rule, the rule behavior might change.
You can create the following types of rules:
- Custom query: Searches the defined indices and creates an alert when a document matches the rule's KQL query.
- Event correlation: Searches the defined indices and creates an alert when results match an Event Query Language (EQL) query.
- Threshold: Searches the defined indices and creates an alert when the number of times the specified field's value meets the threshold during a single execution. When there are multiple values that meet the threshold, an alert is generated for each value.
For example, if the threshold
field
issource.ip
and itsvalue
is10
, an alert is generated for every source IP address that appears in at least 10 of the rule's search results. If you're interested, see Terms Aggregation for more information. - Indicator match: Creates an alert when fields match values defined in the specified Elasticsearch index. For example, you can create an index for IP addresses and use this index to create an alert whenever an event's
destination.ip
equals a value in the index. The index's field mappings should be ECS-compliant. - New terms: Generates an alert for each new term detected in source documents within a specified time range.
- ES|QL: Uses Elasticsearch Query Language (ES|QL) to find events and aggregate search results.
- Machine learning rules: Creates an alert when a machine learning job discovers an anomaly above the defined threshold.
To create machine learning rules, you must have the appropriate license or use a cloud deployment. Additionally, for the machine learning rule to function correctly, the associated machine learning job must be running.
To retrieve machine learning job IDs, which are required to create machine learning jobs, call the Elasticsearch Get jobs API. Machine learning jobs that contain siem
in the groups
field can be used to create rules:
...
"job_id": "linux_anomalous_network_activity_ecs",
"job_type": "anomaly_detector",
"job_version": "7.7.0",
"groups": [
"auditbeat",
"process",
"siem"
],
...
Additionally, you can set up notifications for when rules create alerts. The notifications use the Alerting and Actions framework. Each action type requires a connector. Connectors store the information required to send notifications via external systems. The following connector types are supported for rule notifications:
- Slack
- PagerDuty
- Webhook
- Microsoft Teams
- IBM Resilient
- Jira
- ServiceNow ITSM
For more information on PagerDuty fields, see Send a v2 Event.
To retrieve connector IDs, which are required to configure rule notifications, call the Find objects API with "type": "action"
in the request payload.
For detailed information on Kibana actions and alerting, and additional API calls, see:
Body
object
Required
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Query language to use
Value is
eql
. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Rule type
Value is
eql
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Sets a secondary field for sorting events
-
Specifies the name of the event timestamp field used for sorting a sequence of events. Not to be confused with
timestamp_override
, which specifies the more general field used for querying events within a range. Defaults to the @timestamp ECS field.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Rule type
Value is
query
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Kibana saved search used by the rule to create alerts.
-
Values are
kuery
orlucene
. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Kibana saved search used by the rule to create alerts.
-
Rule type
Value is
saved_query
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Values are
kuery
orlucene
.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Hide threshold attributes Show threshold attributes object
-
The field on which the cardinality is applied.
-
The threshold value from which an alert is generated.
Minimum value is
1
.
-
-
Rule type
Value is
threshold
. -
Defines alert suppression configuration.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Kibana saved search used by the rule to create alerts.
-
Values are
kuery
orlucene
.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Elasticsearch indices used to check which field values generate alerts.
-
Array of entries objects that define mappings between the source event fields and the values in the Elasticsearch threat index. Each entries object must contain these fields:
- field: field from the event indices on which the rule runs
- type: must be mapping
- value: field from the Elasticsearch threat index
You can use Boolean and and or logic to define the conditions for when matching fields and values generate alerts. Sibling entries objects are evaluated using or logic, whereas multiple entries in a single entries object use and logic. See Example of Threat Match rule which uses both
and
andor
logic.At least
1
element.Hide threat_mapping attribute Show threat_mapping attribute object
-
Hide entries attributes Show entries attributes object
-
Query used to determine which fields in the Elasticsearch index are used for generating alerts.
-
Rule type
Value is
threat_match
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
Minimum value is
1
. -
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Minimum value is
1
. -
Kibana saved search used by the rule to create alerts.
-
Query and filter context array used to filter documents from the Elasticsearch index containing the threat values
-
Defines the path to the threat indicator in the indicator documents (optional)
-
Values are
kuery
orlucene
. -
Values are
kuery
orlucene
.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Anomaly score threshold above which the rule creates an alert. Valid values are from 0 to 100.
Minimum value is
0
. -
Rule type
Value is
machine_learning
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Start date to use when checking if a term has been seen before. Supports relative dates – for example, now-30d will search the last 30 days of data when checking if a term is new. We do not recommend using absolute dates, which can cause issues with rule performance due to querying increasing amounts of data over time.
Minimum length is
1
. -
Fields to monitor for new values.
At least
1
but not more than3
elements. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Rule type
Value is
new_terms
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Values are
kuery
orlucene
.
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. -
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
Value is
esql
. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Rule type
Value is
esql
.
Responses
-
Indicates a successful call.
Any of: Security_Detections_API_EqlRuleResponseFieldsobject Security_Detections_API_QueryRuleResponseFieldsobject Security_Detections_API_SavedQueryRuleResponseFieldsobject Security_Detections_API_ThresholdRuleResponseFieldsobject Security_Detections_API_ThreatMatchRuleResponseFieldsobject Security_Detections_API_MachineLearningRuleResponseFieldsobject Security_Detections_API_NewTermsRuleResponseFieldsobject Security_Detections_API_EsqlRuleResponseFieldsobject Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Query language to use
Value is
eql
. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Rule type
Value is
eql
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Sets a secondary field for sorting events
-
Specifies the name of the event timestamp field used for sorting a sequence of events. Not to be confused with
timestamp_override
, which specifies the more general field used for querying events within a range. Defaults to the @timestamp ECS field.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Rule type
Value is
query
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Kibana saved search used by the rule to create alerts.
-
Values are
kuery
orlucene
. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Kibana saved search used by the rule to create alerts.
-
Rule type
Value is
saved_query
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Values are
kuery
orlucene
.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Hide threshold attributes Show threshold attributes object
-
The field on which the cardinality is applied.
-
The threshold value from which an alert is generated.
Minimum value is
1
.
-
-
Rule type
Value is
threshold
. -
Defines alert suppression configuration.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Kibana saved search used by the rule to create alerts.
-
Values are
kuery
orlucene
.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Elasticsearch indices used to check which field values generate alerts.
-
Array of entries objects that define mappings between the source event fields and the values in the Elasticsearch threat index. Each entries object must contain these fields:
- field: field from the event indices on which the rule runs
- type: must be mapping
- value: field from the Elasticsearch threat index
You can use Boolean and and or logic to define the conditions for when matching fields and values generate alerts. Sibling entries objects are evaluated using or logic, whereas multiple entries in a single entries object use and logic. See Example of Threat Match rule which uses both
and
andor
logic.At least
1
element.Hide threat_mapping attribute Show threat_mapping attribute object
-
Hide entries attributes Show entries attributes object
-
Query used to determine which fields in the Elasticsearch index are used for generating alerts.
-
Rule type
Value is
threat_match
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
Minimum value is
1
. -
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Minimum value is
1
. -
Kibana saved search used by the rule to create alerts.
-
Query and filter context array used to filter documents from the Elasticsearch index containing the threat values
-
Defines the path to the threat indicator in the indicator documents (optional)
-
Values are
kuery
orlucene
. -
Values are
kuery
orlucene
.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Anomaly score threshold above which the rule creates an alert. Valid values are from 0 to 100.
Minimum value is
0
. -
Rule type
Value is
machine_learning
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Start date to use when checking if a term has been seen before. Supports relative dates – for example, now-30d will search the last 30 days of data when checking if a term is new. We do not recommend using absolute dates, which can cause issues with rule performance due to querying increasing amounts of data over time.
Minimum length is
1
. -
Fields to monitor for new values.
At least
1
but not more than3
elements. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Rule type
Value is
new_terms
. -
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
The query and filter context array used to define the conditions for when alerts are created from events. Defaults to an empty array.
This field is not supported for ES|QL rules.
-
Indices on which the rule functions. Defaults to the Security Solution indices defined on the Kibana Advanced Settings page (Kibana → Stack Management → Advanced Settings →
securitySolution:defaultIndex
).This field is not supported for ES|QL rules.
-
Values are
kuery
orlucene
.
Hide attributes Show attributes
-
Array defining the automated actions (notifications) taken when alerts are generated.
Hide actions attributes Show actions attributes object
-
The action type used for sending notifications, can be:
.slack
.slack_api
.email
.index
.pagerduty
.swimlane
.webhook
.servicenow
.servicenow-itom
.servicenow-sir
.jira
.resilient
.opsgenie
.teams
.torq
.tines
.d3security
-
Object containing an action’s conditional filters.
timeframe
(object, optional): Object containing the time frame for when this action can be run.days
(array of integers, required): List of days of the week on which this action will be run. Days of the week are expressed as numbers between1-7
, where1
is Monday and7
is Sunday. To select all days of the week, enter an empty array.hours
(object, required): The hours of the day during which this action will run. Hours of the day are expressed as two strings in the formathh:mm
in24
hour time. A start of00:00
and an end of24:00
means the action can run all day.- start (string, required): Start time in
hh:mm
format. - end (string, required): End time in
hh:mm
format.
- start (string, required): Start time in
timezone
(string, required): An ISO timezone name, such asEurope/Madrid
orAmerica/New_York
. Specific offsets such asUTC
orUTC+1
will also work, but lack built-in DST.
query
(object, optional): Object containing a query filter which gets applied to an action and determines whether the action should run.kql
(string, required): A KQL string.filters
(array of objects, required): Array of filter objects, as defined in thekbn-es-query
package.
Additional properties are allowed.
-
The action frequency defines when the action runs (for example, only on rule execution or at specific time intervals).
Hide frequency attributes Show frequency attributes object
-
Defines how often rules run actions.
Values are
onActiveAlert
,onThrottleInterval
, oronActionGroupChange
. -
Action summary indicates whether we will send a summary notification about all the generate alerts or notification per individual alert
-
-
Optionally groups actions by use cases. Use
default
for alert notifications. -
The connector ID.
-
Object containing the allowed connector fields, which varies according to the connector type.
For Slack:
message
(string, required): The notification message.
For email:
to
,cc
,bcc
(string): Email addresses to which the notifications are sent. At least one field must have a value.subject
(string, optional): Email subject line.message
(string, required): Email body text.
For Webhook:
body
(string, required): JSON payload.
For PagerDuty:
severity
(string, required): Severity of on the alert notification, can be:Critical
,Error
,Warning
orInfo
.eventAction
(string, required): Event action type, which can betrigger
,resolve
, oracknowledge
.dedupKey
(string, optional): Groups alert notifications with the same PagerDuty alert.timestamp
(DateTime, optional): ISO-8601 format timestamp.component
(string, optional): Source machine component responsible for the event, for examplesecurity-solution
.group
(string, optional): Enables logical grouping of service components.source
(string, optional): The affected system. Defaults to the Kibana saved object ID of the action.summary
(string, options): Summary of the event. Defaults toNo summary provided
. Maximum length is 1024 characters.class
(string, optional): Value indicating the class/type of the event.
Additional properties are allowed.
-
A string that does not contain only whitespace characters
Minimum length is
1
.
-
-
Values are
savedObjectConversion
orsavedObjectImport
. -
The rule’s author.
-
Determines if the rule acts as a building block. If yes, the value must be
default
. By default, building-block alerts are not displayed in the UI. These rules are used as a foundation for other rules that do generate alerts. For more information, refer to About building block rules. -
The rule’s description.
Minimum length is
1
. -
Determines whether the rule is enabled. Defaults to true.
-
Array of exception containers, which define exceptions that prevent the rule from generating alerts even when its other criteria are met.
Hide exceptions_list attributes Show exceptions_list attributes object
-
ID of the exception container
Minimum length is
1
. -
List ID of the exception container
Minimum length is
1
. -
Determines the exceptions validity in rule's Kibana space
Values are
agnostic
orsingle
. -
The exception type
Values are
detection
,rule_default
,endpoint
,endpoint_trusted_apps
,endpoint_events
,endpoint_host_isolation_exceptions
, orendpoint_blocklists
.
-
-
String array used to describe common reasons why the rule may issue false-positive alerts. Defaults to an empty array.
-
Time from which data is analyzed each time the rule runs, using a date math range. For example, now-4200s means the rule analyzes data from 70 minutes before its start time. Defaults to now-6m (analyzes data from 6 minutes before the start time).
-
Frequency of rule execution, using a date math range. For example, "1h" means the rule runs every hour. Defaults to 5m (5 minutes).
-
Schema for fields relating to investigation fields. These are user defined fields we use to highlight in various features in the UI such as alert details flyout and exceptions auto-population from alert.
-
The rule's license.
-
Maximum number of alerts the rule can create during a single run (the rule’s Max alerts per run advanced setting value).
This setting can be superseded by the Kibana configuration setting
xpack.alerting.rules.run.alerts.max
, which determines the maximum alerts generated by any rule in the Kibana alerting framework. For example, ifxpack.alerting.rules.run.alerts.max
is set to 1000, the rule can generate no more than 1000 alerts even ifmax_signals
is set higher.Minimum value is
1
. Default value is100
. -
Placeholder for metadata about the rule.
This field is overwritten when you save changes to the rule’s settings.
Additional properties are allowed.
-
A human-readable name for the rule.
Minimum length is
1
. -
Has no effect.
-
Notes to help investigate alerts produced by the rule.
-
Values are
exactMatch
,aliasMatch
, orconflict
. -
(deprecated) Has no effect.
-
Array containing notes about or references to relevant information about the rule. Defaults to an empty array.
-
Related integration is a potential dependency of a rule. It's assumed that if the user installs one of the related integrations of a rule, the rule might start to work properly because it will have source events (generated by this integration) potentially matching the rule's query.
NOTE: Proper work is not guaranteed, because a related integration, if installed, can be configured differently or generate data that is not necessarily relevant for this rule.
Related integration is a combination of a Fleet package and (optionally) one of the package's "integrations" that this package contains. It is represented by 3 properties:
package
: name of the package (required, unique id)version
: version of the package (required, semver-compatible)integration
: name of the integration of this package (optional, id within the package)
There are Fleet packages like
windows
that contain only one integration; in this case,integration
should be unspecified. There are also packages likeaws
andazure
that contain several integrations; in this case,integration
should be specified.Hide related_integrations attributes Show related_integrations attributes object
-
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
. -
A string that does not contain only whitespace characters
Minimum length is
1
.
-
Elasticsearch fields and their types that need to be present for the rule to function.
The value of
required_fields
does not affect the rule’s behavior, and specifying it incorrectly won’t cause the rule to fail. Userequired_fields
as an informational property to document the fields that the rule expects to be present in the data.Input parameters to create a RequiredField. Does not include the
ecs
field, becauseecs
is calculated on the backend based on the field name and type. -
One of: Hide attributes Show attributes
-
Value is
.osquery
. -
Hide params attributes Show params attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
To specify a query pack, use the packId field. Example: "packId": "processes_elastic"
-
Hide queries attributes Show queries attributes object
-
Map Osquery results columns or static values to Elastic Common Schema (ECS) fields. Example: "ecs_mapping": {"process.pid": {"field": "pid"}}
Hide ecs_mapping attribute Show ecs_mapping attribute object
-
Query ID
-
Query to run
-
Query version
-
-
To run a single query, use the query field and enter a SQL query. Example: "query": "SELECT * FROM processes;"
-
To run a saved query, use the saved_query_id field and specify the saved query ID. Example: "saved_query_id": "processes_elastic"
-
A timeout period, in seconds, after which the query will stop running. Overwriting the default timeout allows you to support queries that require more time to complete. The default and minimum supported value is 60. The maximum supported value is 900. Example: "timeout": 120.
-
Hide attributes Show attributes
-
Value is
.endpoint
. params
object Required One of: Hide attributes Show attributes
-
To run an endpoint response action, specify a value for the command field. Example: "command": "isolate"
Values are
kill-process
orsuspend-process
. -
Add a note that explains or describes the action. You can find your comment in the response actions history log. Example: "comment": "Check processes"
-
-
-
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
. -
Overrides generated alerts' risk_score with a value from the source event
Hide risk_score_mapping attributes Show risk_score_mapping attributes object
-
Source event field used to override the default
risk_score
. -
Value is
equals
. -
A numerical representation of the alert's severity from 0 to 100, where:
0
-21
represents low severity22
-47
represents medium severity48
-73
represents high severity74
-100
represents critical severity
Minimum value is
0
, maximum value is100
.
-
-
Sets which field in the source event is used to populate the alert's
signal.rule.name
value (in the UI, this value is displayed on the Rules page in the Rule column). When unspecified, the rule’sname
value is used. The source field must be a string data type. -
Populates the rule’s setup guide with instructions on rule prerequisites such as required integrations, configuration steps, and anything else needed for the rule to work correctly.
-
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
. -
Overrides generated alerts' severity with values from the source event
Hide severity_mapping attributes Show severity_mapping attributes object
-
Source event field used to override the default
severity
. -
Value is
equals
. -
Severity level of alerts produced by the rule, which must be one of the following:
low
: Alerts that are of interest but generally not considered to be security incidentsmedium
: Alerts that require investigationhigh
: Alerts that require immediate investigationcritical
: Alerts that indicate it is highly likely a security incident has occurred
Values are
low
,medium
,high
, orcritical
.
-
-
String array containing words and phrases to help categorize, filter, and search rules. Defaults to an empty array.
-
Currently, only threats described using the MITRE ATT&CK™ framework are supported.
Hide threat attributes Show threat attributes object
-
Relevant attack framework
-
Object containing information on the attack type
-
Array containing information on the attack techniques (optional)
Hide technique attributes Show technique attributes object
-
Technique ID
-
Technique name
-
Technique reference
-
Array containing more specific information on the attack technique.
-
-
-
Timeline template ID
-
Timeline template title
-
Sets the time field used to query indices. When unspecified, rules query the
@timestamp
field. The source field must be an Elasticsearch date data type. -
Disables the fallback to the event's @timestamp field
-
The rule's version number.
- For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
security_detection_engine
Fleet package that is used for distributing prebuilt rules). - For custom rules it is set to
1
when the rule is created.
It is not incremented on each update. Compare this to the
revision
field.Minimum value is
1
. - For prebuilt rules it represents the version of the rule's content in the source detection-rules repository (and the corresponding
-
Summary of the last execution of a rule.
This field is under development and its usage or schema may change
Hide execution_summary attribute Show execution_summary attribute object
-
Hide last_execution attributes Show last_execution attributes object
-
Date of the last execution
-
Hide metrics attributes Show metrics attributes object
-
Duration in seconds of execution gap
Minimum value is
0
. -
Count of frozen indices queried during the rule execution. These indices could not be entirely excluded after applying the time range filter.
Minimum value is
0
. -
Range of the execution gap
-
Total time spent enriching documents during current rule execution cycle
Minimum value is
0
. -
Total time spent indexing documents during current rule execution cycle
Minimum value is
0
. -
Total time spent performing ES searches as measured by Kibana; includes network latency and time spent serializing/deserializing request/response
Minimum value is
0
.
-
-
Status of the last execution
Values are
going to run
,running
,partial failure
,failed
, orsucceeded
.
-
-
-
A dynamic unique identifier for the rule object. It is randomly generated when a rule is created and cannot be changed after that. It is always a UUID. It is unique within a given Kibana space. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have different object
id
s. -
This field determines whether the rule is a prebuilt Elastic rule. It will be replaced with the
rule_source
field. -
The rule's revision number.
It represents the version of rule's object in Kibana. It is set to
0
when the rule is installed or created and then gets incremented on each update.Not all updates to any rule fields will increment the revision. Only those fields that are considered static
rule parameters
can trigger revision increments. For example, an update to a rule's query or index fields will increment the rule's revision by1
. However, changes to dynamic or technical fields like enabled or execution_summary will not cause revision increments.Minimum value is
0
. -
A stable unique identifier for the rule object. It can be assigned during rule creation. It can be any string, but often is a UUID. It should be unique not only within a given Kibana space, but also across spaces and Elastic environments. The same prebuilt Elastic rule, when installed in two different Kibana spaces or two different Elastic environments, will have the same
rule_id
s. rule_source
object Required Discriminated union that determines whether the rule is internally sourced (created within the Kibana app) or has an external source, such as the Elastic Prebuilt rules repo.
-
Defines alert suppression configuration.
Hide alert_suppression attributes Show alert_suppression attributes object
-
At least
1
but not more than3
elements. -
Describes how alerts will be generated for documents with missing suppress by fields: doNotSuppress - per each document a separate alert will be created suppress - only alert will be created per suppress by bucket
Values are
doNotSuppress
orsuppress
.
-
Value is
esql
. -
Query used by the rule to create alerts.
- For indicator match rules, only the query’s results are used to determine whether an alert is generated.
- ES|QL rules have additional query requirements. Refer to Create ES|QL rules for more information.
-
Rule type
Value is
esql
.
-
curl \
--request POST 'https://<KIBANA_URL>/api/detection_engine/rules' \
--header "Authorization: $API_KEY" \
--header "Content-Type: application/json" \
--data '{"from":"now-70m","name":"MS Office child process","tags":["child process","ms office"],"type":"query","query":"process.parent.name:EXCEL.EXE or process.parent.name:MSPUB.EXE or process.parent.name:OUTLOOK.EXE or process.parent.name:POWERPNT.EXE or process.parent.name:VISIO.EXE or process.parent.name:WINWORD.EXE","enabled":false,"filters":[{"query":{"match":{"event.action":{"type":"phrase","query":"Process Create (rule: ProcessCreate)"}}}}],"rule_id":"process_started_by_ms_office_program","interval":"1h","language":"kuery","severity":"low","risk_score":50,"description":"Process started by MS Office program - possible payload","required_fields":[{"name":"process.parent.name","type":"keyword"}],"related_integrations":[{"package":"o365","version":"^2.3.2"}]}'
{
"from": "now-70m",
"name": "MS Office child process",
"tags": [
"child process",
"ms office"
],
"type": "query",
"query": "process.parent.name:EXCEL.EXE or process.parent.name:MSPUB.EXE or process.parent.name:OUTLOOK.EXE or process.parent.name:POWERPNT.EXE or process.parent.name:VISIO.EXE or process.parent.name:WINWORD.EXE",
"enabled": false,
"filters": [
{
"query": {
"match": {
"event.action": {
"type": "phrase",
"query": "Process Create (rule: ProcessCreate)"
}
}
}
}
],
"rule_id": "process_started_by_ms_office_program",
"interval": "1h",
"language": "kuery",
"severity": "low",
"risk_score": 50,
"description": "Process started by MS Office program - possible payload",
"required_fields": [
{
"name": "process.parent.name",
"type": "keyword"
}
],
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
}
]
}
{
"from": "now-180s",
"name": "Windows server prml-19",
"tags": [
"Brute force"
],
"type": "threshold",
"index": [
"winlogbeat-*"
],
"query": "host.name:prml-19 and event.category:authentication and event.outcome:failure",
"enabled": true,
"rule_id": "liv-win-ser-logins",
"interval": "2m",
"severity": "low",
"threshold": {
"field": "source.ip",
"value": 20
},
"risk_score": 30,
"description": "Detects when there are 20 or more failed login attempts from the same IP address with a 2 minute time frame.",
"exceptions_list": [
{
"id": "int-ips",
"type": "detection",
"namespace_type": "single"
}
],
"required_fields": [
{
"name": "source.ip",
"type": "ip"
}
],
"severity_mapping": [
{
"field": "source.geo.city_name",
"value": "Manchester",
"operator": "equals",
"severity": "low"
},
{
"field": "source.geo.city_name",
"value": "London",
"operator": "equals",
"severity": "medium"
},
{
"field": "source.geo.city_name",
"value": "Birmingham",
"operator": "equals",
"severity": "high"
},
{
"field": "source.geo.city_name",
"value": "Wallingford",
"operator": "equals",
"severity": "critical"
}
]
}
{
"from": "now-6m",
"name": "Anomalous Linux network activity",
"note": "Shut down the internet.",
"tags": [
"machine learning",
"Linux"
],
"type": "machine_learning",
"setup": "This rule requires data coming in from Elastic Defend.",
"actions": [
{
"id": "5ad22cd5-5e6e-4c6c-a81a-54b626a4cec5",
"group": "default",
"params": {
"message": "Urgent: {{context.rule.description}}"
},
"action_type_id": ".slack"
}
],
"enabled": true,
"rule_id": "ml_linux_network_high_threshold",
"interval": "5m",
"severity": "high",
"risk_score": 70,
"description": "Generates alerts when the job discovers anomalies over 70",
"anomaly_threshold": 70,
"machine_learning_job_id": "linux_anomalous_network_activity_ecs"
}
{
"name": "rundll32.exe network connection",
"tags": [
"EQL",
"Windows",
"rundll32.exe"
],
"type": "eql",
"query": "sequence by process.entity_id with maxspan=2h [process where event.type in (\"start\", \"process_started\") and (process.name == \"rundll32.exe\" or process.pe.original_file_name == \"rundll32.exe\") and ((process.args == \"rundll32.exe\" and process.args_count == 1) or (process.args != \"rundll32.exe\" and process.args_count == 0))] [network where event.type == \"connection\" and (process.name == \"rundll32.exe\" or process.pe.original_file_name == \"rundll32.exe\")]",
"rule_id": "eql-outbound-rundll32-connections",
"language": "eql",
"severity": "low",
"risk_score": 21,
"description": "Unusual rundll32.exe network connection",
"required_fields": [
{
"name": "event.type",
"type": "keyword"
},
{
"name": "process.args",
"type": "keyword"
},
{
"name": "process.args_count",
"type": "long"
},
{
"name": "process.entity_id",
"type": "keyword"
},
{
"name": "process.name",
"type": "keyword"
},
{
"name": "process.pe.original_file_name",
"type": "keyword"
}
]
}
{
"name": "Bad IP threat match",
"type": "threat_match",
"index": [
"packetbeat-*"
],
"query": "destination.ip:* or host.ip:*",
"actions": [],
"severity": "medium",
"risk_score": 50,
"description": "Checks for bad IP addresses listed in the ip-threat-list index",
"threat_index": [
"ip-threat-list"
],
"threat_query": "*:*",
"threat_mapping": [
{
"entries": [
{
"type": "mapping",
"field": "destination.ip",
"value": "destination.ip"
},
{
"type": "mapping",
"field": "destination.port",
"value": "destination.port"
}
]
},
{
"entries": [
{
"type": "mapping",
"field": "source.ip",
"value": "host.ip"
}
]
}
],
"required_fields": [
{
"name": "destination.ip",
"type": "ip"
},
{
"name": "destination.port",
"type": "long"
},
{
"name": "host.ip",
"type": "ip"
}
]
}
{
"name": "New User IP Detected",
"type": "new_terms",
"index": [
"auditbeat*"
],
"query": "*",
"language": "kuery",
"severity": "medium",
"risk_score": 21,
"description": "Detects a user associated with a new IP address",
"required_fields": [
{
"name": "user.id",
"type": "keyword"
},
{
"name": "source.ip",
"type": "ip"
}
],
"new_terms_fields": [
"user.id",
"source.ip"
],
"history_window_start": "now-30d"
}
{
"to": "now",
"from": "now-360s",
"name": "Find Excel events",
"tags": [],
"type": "esql",
"query": "from auditbeat-8.10.2 METADATA _id, _version, _index | where process.parent.name == \"EXCEL.EXE\"",
"enabled": false,
"interval": "5m",
"language": "esql",
"severity": "low",
"risk_score": 21,
"description": "Find Excel events",
"required_fields": [
{
"name": "process.parent.name",
"type": "keyword"
}
]
}
{
"from": "now-70m",
"name": "MS Office child process",
"tags": [
"child process",
"ms office"
],
"type": "query",
"query": "process.parent.name:EXCEL.EXE or process.parent.name:MSPUB.EXE or process.parent.name:OUTLOOK.EXE or process.parent.name:POWERPNT.EXE or process.parent.name:VISIO.EXE or process.parent.name:WINWORD.EXE",
"enabled": false,
"filters": [
{
"query": {
"match": {
"event.action": {
"type": "phrase",
"query": "Process Create (rule: ProcessCreate)"
}
}
}
}
],
"rule_id": "process_started_by_ms_office_program",
"interval": "1h",
"language": "kuery",
"severity": "low",
"risk_score": 50,
"description": "Process started by MS Office program - possible payload",
"alert_suppression": {
"duration": {
"unit": "h",
"value": 5
},
"group_by": [
"process.parent.name"
],
"missing_fields_strategy": "suppress"
}
}
{
"id": "6541b99a-dee9-4f6d-a86d-dbd1869d73b1",
"to": "now",
"from": "now-70m",
"name": "MS Office child process",
"tags": [
"child process",
"ms office"
],
"type": "query",
"query": "process.parent.name:EXCEL.EXE or process.parent.name:MSPUB.EXE or process.parent.name:OUTLOOK.EXE or process.parent.name:POWERPNT.EXE or process.parent.name:VISIO.EXE or process.parent.name:WINWORD.EXE",
"setup": "",
"threat": [],
"actions": [],
"enabled": false,
"filters": [
{
"query": {
"match": {
"event.action": {
"type": "phrase",
"query": "Process Create (rule: ProcessCreate)"
}
}
}
}
],
"rule_id": "process_started_by_ms_office_program",
"version": 1,
"interval": "1h",
"language": "kuery",
"severity": "low",
"immutable": false,
"created_at": "2020-04-07T14:51:09.755Z",
"created_by": "elastic",
"references": [],
"risk_score": 50,
"updated_at": "2020-04-07T14:51:09.970Z",
"updated_by": "elastic",
"description": "Process started by MS Office program - possible payload",
"max_signals": 100,
"false_positives": [],
"required_fields": [
{
"ecs": true,
"name": "process.parent.name",
"type": "keyword"
}
],
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
},
{
"package": "azure",
"version": "^1.11.4",
"integration": "graphactivitylogs"
}
]
}
{
"id": "83876f66-3a57-4a99-bf37-416494c80f3b",
"to": "now",
"from": "now-6m",
"name": "Anomalous Linux network activity",
"note": "Shut down the internet.",
"tags": [
"machine learning",
"Linux"
],
"type": "machine_learning",
"setup": "",
"status": "going to run",
"threat": [],
"actions": [
{
"id": "5ad22cd5-5e6e-4c6c-a81a-54b626a4cec5",
"group": "default",
"params": {
"message": "Urgent: {{context.rule.description}}"
},
"frequency": {
"summary": true,
"throttle": null,
"notifyWhen": "onActiveAlert"
},
"action_type_id": ".slack"
}
],
"enabled": true,
"rule_id": "ml_linux_network_high_threshold",
"version": 1,
"interval": "5m",
"severity": "high",
"immutable": false,
"created_at": "2020-04-07T14:45:15.679Z",
"created_by": "elastic",
"references": [],
"risk_score": 70,
"updated_at": "2020-04-07T14:45:15.892Z",
"updated_by": "elastic",
"description": "Generates alerts when the job discovers anomalies over 70",
"max_signals": 100,
"status_date": "2020-04-07T14:45:21.685Z",
"false_positives": [],
"required_fields": [],
"anomaly_threshold": 70,
"related_integrations": [],
"machine_learning_job_id": "linux_anomalous_network_activity_ecs"
}
{
"id": "15dbde26-b627-4d74-bb1f-a5e0ed9e4993",
"to": "now",
"from": "now-180s",
"name": "Windows server prml-19",
"tags": [
"Brute force"
],
"type": "threshold",
"index": [
"winlogbeat-*"
],
"query": "host.name:prml-19 and event.category:authentication and event.outcome:failure",
"setup": "",
"author": [],
"threat": [],
"actions": [],
"enabled": true,
"rule_id": "liv-win-ser-logins",
"version": 1,
"interval": "2m",
"language": "kuery",
"severity": "low",
"immutable": false,
"threshold": {
"field": "source.ip",
"value": 20
},
"created_at": "2020-07-22T10:27:23.486Z",
"created_by": "elastic",
"references": [],
"risk_score": 30,
"updated_at": "2020-07-22T10:27:23.673Z",
"updated_by": "elastic",
"description": "Detects when there are 20 or more failed login attempts from the same IP address with a 2 minute time frame.",
"max_signals": 100,
"exceptions_list": [
{
"id": "int-ips",
"type": "detection",
"namespace_type": "single"
}
],
"false_positives": [],
"required_fields": [
{
"ecs": true,
"name": "source.ip",
"type": "ip"
}
],
"severity_mapping": [
{
"field": "source.geo.city_name",
"value": "Manchester",
"operator": "equals",
"severity": "low"
},
{
"field": "source.geo.city_name",
"value": "London",
"operator": "equals",
"severity": "medium"
},
{
"field": "source.geo.city_name",
"value": "Birmingham",
"operator": "equals",
"severity": "high"
},
{
"field": "source.geo.city_name",
"value": "Wallingford",
"operator": "equals",
"severity": "critical"
}
],
"risk_score_mapping": [],
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
}
]
}
{
"id": "93808cae-b05b-4dc9-8479-73574b50f8b1",
"to": "now",
"from": "now-6m",
"name": "rundll32.exe network connection",
"tags": [
"EQL",
"Windows",
"rundll32.exe"
],
"type": "eql",
"query": "sequence by process.entity_id with maxspan=2h [process where event.type in (\"start\", \"process_started\") and (process.name == \"rundll32.exe\" or process.pe.original_file_name == \"rundll32.exe\") and ((process.args == \"rundll32.exe\" and process.args_count == 1) or (process.args != \"rundll32.exe\" and process.args_count == 0))] [network where event.type == \"connection\" and (process.name == \"rundll32.exe\" or process.pe.original_file_name == \"rundll32.exe\")]",
"setup": "",
"author": [],
"threat": [],
"enabled": true,
"rule_id": "eql-outbound-rundll32-connections",
"version": 1,
"interval": "5m",
"language": "eql",
"severity": "low",
"throttle": "no_actions",
"immutable": false,
"created_at": "2020-10-05T09:06:16.392Z",
"created_by": "elastic",
"references": [],
"risk_score": 21,
"updated_at": "2020-10-05T09:06:16.403Z",
"updated_by": "elastic",
"description": "Unusual rundll32.exe network connection",
"max_signals": 100,
"exceptions_list": [],
"false_positives": [],
"required_fields": [
{
"ecs": true,
"name": "event.type",
"type": "keyword"
},
{
"ecs": true,
"name": "process.args",
"type": "keyword"
},
{
"ecs": true,
"name": "process.args_count",
"type": "long"
},
{
"ecs": true,
"name": "process.entity_id",
"type": "keyword"
},
{
"ecs": true,
"name": "process.name",
"type": "keyword"
},
{
"ecs": true,
"name": "process.pe.original_file_name",
"type": "keyword"
}
],
"severity_mapping": [],
"risk_score_mapping": [],
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
}
]
}
{
"id": "d5daa13f-81fb-4b13-be2f-31011e1d9ae1",
"to": "now",
"from": "now-6m",
"name": "Bad IP threat match",
"tags": [],
"type": "threat_match",
"index": [
"packetbeat-*"
],
"query": "destination.ip:* or host.ip:*",
"setup": "",
"author": [],
"threat": [],
"enabled": true,
"rule_id": "608501e4-c768-4f64-9326-cec55b5d439b",
"version": 1,
"interval": "5m",
"language": "kuery",
"severity": "medium",
"immutable": false,
"created_at": "2020-10-06T07:07:58.227Z",
"created_by": "elastic",
"references": [],
"risk_score": 50,
"updated_at": "2020-10-06T07:07:58.237Z",
"updated_by": "elastic",
"description": "Checks for bad IP addresses listed in the ip-threat-list index",
"max_signals": 100,
"threat_index": [
"ip-threat-list"
],
"threat_query": "*:*",
"threat_mapping": [
{
"entries": [
{
"type": "mapping",
"field": "destination.ip",
"value": "destination.ip"
},
{
"type": "mapping",
"field": "destination.port",
"value": "destination.port"
}
]
},
{
"entries": [
{
"type": "mapping",
"field": "source.ip",
"value": "host.ip"
}
]
}
],
"exceptions_list": [],
"false_positives": [],
"required_fields": [
{
"ecs": true,
"name": "destination.ip",
"type": "ip"
},
{
"ecs": true,
"name": "destination.port",
"type": "long"
},
{
"ecs": true,
"name": "host.ip",
"type": "ip"
}
],
"severity_mapping": [],
"risk_score_mapping": [],
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
}
]
}
{
"id": "eb7225c0-566b-11ee-8b4f-bbf3afdeb9f4",
"to": "now",
"from": "now-6m",
"name": "New User IP Detected",
"tags": [],
"type": "new_terms",
"index": [
"auditbeat*"
],
"query": "*",
"setup": "",
"author": [],
"threat": [],
"enabled": true,
"rule_id": "c6f5d0bc-7be9-47d4-b2f3-073d22641e30",
"version": 1,
"interval": "5m",
"language": "kuery",
"severity": "medium",
"immutable": false,
"created_at": "2020-10-06T07:07:58.227Z",
"created_by": "elastic",
"references": [],
"risk_score": 21,
"updated_at": "2020-10-06T07:07:58.237Z",
"updated_by": "elastic",
"description": "Detects a user associated with a new IP address",
"max_signals": 100,
"exceptions_list": [],
"false_positives": [],
"required_fields": [
{
"ecs": true,
"name": "user.id",
"type": "keyword"
},
{
"ecs": true,
"name": "source.ip",
"type": "ip"
}
],
"new_terms_fields": [
"user.id",
"source.ip"
],
"severity_mapping": [],
"risk_score_mapping": [],
"history_window_start": "now-30d",
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
}
]
}
{
"id": "d0f20490-6da4-11ee-b85e-09e9b661f2e2",
"to": "now",
"from": "now-360s",
"name": "Find Excel events",
"tags": [],
"type": "esql",
"query": "from auditbeat-8.10.2 METADATA _id | where process.parent.name == \"EXCEL.EXE\"",
"setup": "",
"author": [],
"threat": [],
"actions": [],
"enabled": false,
"rule_id": "e4b53a89-debd-4a0d-a3e3-20606952e589",
"version": 1,
"interval": "5m",
"language": "esql",
"revision": 0,
"severity": "low",
"immutable": false,
"created_at": "2023-10-18T10:55:14.269Z",
"created_by": "elastic",
"references": [],
"risk_score": 21,
"updated_at": "2023-10-18T10:55:14.269Z",
"updated_by": "elastic",
"description": "Find Excel events",
"max_signals": 100,
"output_index": "",
"exceptions_list": [],
"false_positives": [],
"required_fields": [
{
"ecs": true,
"name": "process.parent.name",
"type": "keyword"
}
],
"severity_mapping": [],
"risk_score_mapping": [],
"related_integrations": [
{
"package": "o365",
"version": "^2.3.2"
}
]
}