The Rules page allows you to view and manage all prebuilt and custom detection rules.
On the Rules page, you can:
- Sort and filter the rules list
- Check the current status of rules
- Load and activate Elastic prebuilt rules
- Select and duplicate all prebuilt rules
- Download latest Elastic prebuilt rules
- Confirm rule prerequisites
- Modify existing rules settings
- Manage rules
- Snooze rule actions
- Export and import rules
- Troubleshoot missing alerts
Sort and filter the rules listedit
To sort the rules list, click any column header. To sort in descending order, click the column header again.
To filter the rules list, enter a search term in the search bar and press Return:
- Rule name — Enter a word or phrase from a rule’s name.
Index pattern — Enter an index pattern (such as
filebeat-*) to display all rules that use it.
MITRE ATT&CK tactic or technique — Enter a MITRE ATT&CK tactic name (such as
Defense Evasion) or technique number (such as
TA0005) to display all associated rules.
Searches for index patterns and MITRE ATT&CK tactics and techniques must match exactly, are case sensitive, and do not support wildcards. For example, to find rules using the
filebeat-* index pattern, the search term
filebeat-* is valid, but
file* are not because they don’t exactly match the index pattern. Likewise, the MITRE ATT&CK tactic
Defense Evasion is valid, but
defense evasion, and
Defense* are not.
You can also filter the rules list by selecting the Tags, Elastic rules, Custom rules, Enabled rules, and Disabled rules filters next to the search bar.
The rules list retains your sorting and filtering settings when you navigate away and return to the page. These settings are also preserved when you copy the page’s URL and paste into another browser. Select Clear filters above the table to revert to the default view.
Check the current status of rulesedit
The Last response column displays the current status of each rule, based on the most recent attempt to run the rule:
- Succeeded: The rule completed its defined search. This doesn’t necessarily mean it generated an alert, just that it ran without error.
- Failed: The rule encountered an error that prevented it from running. For example, a machine learning rule whose corresponding machine learning job wasn’t running.
- Warning: Nothing prevented the rule from running, but it might have returned unexpected results. For example, a custom query rule tried to search an index pattern that couldn’t be found in Elasticsearch.
For machine learning rules, an indicator icon () also appears in this column if a required machine learning job isn’t running. Click the icon to list the affected jobs, then click Visit rule details page to investigate to open the rule’s details page, where you can start the machine learning job.
Load and activate Elastic prebuilt rulesedit
To load the Elastic Security app’s prebuilt rules, go to Manage → Rules → Load Elastic prebuilt rules and Timeline templates.
You can then activate whichever rules you want. If you delete any prebuilt rules, a button appears that enables you to reload all of the deleted ones.
Apart from the Elastic Endpoint rule, prebuilt rules are not activated by
default. If you want to modify a prebuilt rule, you must first duplicate it, then make your changes to the duplicated rule. All Elastic prebuilt rules are tagged with the word
To learn how to enable detection rules in Elastic Security, watch the tutorial at the end of this topic.
Select and duplicate all prebuilt rulesedit
- Go to Manage → Rules.
- Click Select all x rules above the rules table.
- Click Bulk actions → Duplicate.
- Select the Custom rules tab.
You can then modify the duplicated rules and, if required, delete the prebuilt ones.
Download latest Elastic prebuilt rulesedit
As of Elastic Stack >=7.13.0, you can download the latest version of Elastic prebuilt rules outside of a regular release cycle. This feature ensures you have the latest detection capabilities before upgrading to the latest Elastic Stack.
To download the latest version of prebuilt rules:
- In Kibana, go to Management → Integrations.
- Search for "Prebuilt Security Detection Rules."
Select the integration, then select the Settings tab. The integration settings page is displayed.
- Click Install Prebuilt Security Detection Rules assets.
Click Install Prebuilt Security Detection Rules to confirm the installation.
Confirm rule prerequisitesedit
Many Elastic prebuilt rules are designed to work with specific Elastic integrations and data fields. These prerequisites are identified in the Related integrations and Required fields fields on a rule’s details page (Manage → Rules, then click a rule’s name). Related integrations also displays each integration’s installation status and includes links for installing and configuring the listed integrations.
Additionally, the Setup guide section provides guidance on setting up the rule’s requirements.
You can also check rules' related integrations in the Rules and Rule Monitoring tables. Click the integrations badge to display the related integrations in a popup.
You can hide the integrations badge in the Rules tables. Go to Kibana → Stack Management → Advanced Settings, then turn off
Modify existing rules settingsedit
You can edit an existing rule’s settings, and can bulk edit settings for multiple rules at once.
For prebuilt Elastic rules, you can’t modify most settings. You can only edit rule actions and add exceptions. If you try to bulk edit with both prebuilt and custom rules selected, the action will affect only the rules that can be modified.
Similarly, rules will be skipped if they can’t be modified by a bulk edit. For example, if you try to apply a tag to rules that already have that tag, or apply an index pattern to rules that use data views.
- Go to Manage → Rules.
Do one of the following:
- Edit a single rule: Select the All actions menu (…) on a rule, then select Edit rule settings. The Edit rule settings view opens, where you can modify the rule’s settings.
Bulk edit multiple rules: Select the rules you want to edit, then select an action from the Bulk actions menu:
- Index patterns: Add or delete the index patterns used by all selected rules.
- Tags: Add or delete tags on all selected rules.
- Add rule actions: Add rule actions on all selected rules. If you add multiple actions, you can specify an action frequency for each of them. To overwrite the frequency of existing actions select the option to Overwrite all selected rules actions.
After upgrading to 8.8 or later, frequency settings for rule actions created in 8.7 or earlier are moved from the rule level to the action level. The action schedules remain the same and will continue to run on their previously specified frequency (
On each rule execution,
Rule actions won’t run during a maintenance window. They’ll resume running after the maintenance window ends.
- Update rule schedules: Update the schedules and look-back times on all selected rules.
- Apply Timeline template: Apply a specified Timeline template to the selected rules. You can also choose None to remove Timeline templates from the selected rules.
On the flyout that opens, update the rule settings and actions.
To snooze rule actions, go to the Actions tab and click the bell icon.
- If available, select Overwrite all selected x to overwrite the settings on the rules. For example, if you’re adding tags to multiple rules, selecting Overwrite all selected rules tags removes all the rules' original tags and replaces them with the tags you specify.
- Click Save.
You can duplicate, enable, disable, delete, and snooze actions for rules:
When duplicating a rule with exceptions, you can choose to duplicate the rule and its exceptions (active and expired), the rule and active exceptions only, or only the rule. If you duplicate the rule and its exceptions, copies of the exceptions are created and added to the duplicated rule’s default rule list. If the original rule used exceptions from a shared exception list, the duplicated rule will reference the same shared exception list.
- Go to Manage → Rules.
Do one of the following:
- Select the All actions menu (…) on a rule, then select an action.
- Select all the rules you want to modify, then select an action from the Bulk actions menu.
- To enable or disable a single rule, switch on the rule’s Enabled toggle.
- To snooze actions for rules, click the bell icon.
Snooze rule actionsedit
Instead of turning rules off to stop alert notifications, you can snooze rule actions for a specified time period. When you snooze rule actions, the rule continues to run on its defined schedule, but won’t perform any actions or send alert notifications.
You can snooze notifications temporarily or indefinitely. When actions are snoozed, you can cancel or change the duration of the snoozed state. You can also schedule and manage recurring downtime for actions.
You can snooze rule notifications from the Rules table, the rule details page, or the Actions tab when editing a rule.
Export and import rulesedit
You can export custom detection rules to an
.ndjson file, which you can then import into another Elastic Security environment.
You cannot export Elastic prebuilt rules, but you can duplicate a prebuilt rule, then export the duplicated rule.
If you try to export with both prebuilt and custom rules selected, only the custom rules are exported.
.ndjson file also includes any actions, connectors, and exception lists related to the exported rules. However, other configuration items require additional handling when exporting and importing rules:
Data views: For rules that use a Kibana data view as a data source, the exported file contains the associated
data_view_id, but does not include any other data view configuration. To export/import between Kibana spaces, first use the Saved Objects UI (Stack Management → Kibana → Saved Objects) to share the data view with the destination space.
To import into a different Elastic Stack deployment, the destination cluster must include a data view with a matching data view ID (configured in the data view’s advanced settings). Alternatively, after importing, you can manually reconfigure the rule to use an appropriate data view in the destination system.
Actions and connectors: Rule actions and connectors are included in the exported file, but sensitive information about the connector (such as authentication credentials) is not included. You must re-add missing connector details after importing detection rules.
You can also use Kibana’s Saved Objects UI (Stack Management → Kibana → Saved Objects) to export and import necessary connectors before importing detection rules.
- Value lists: Any value lists used for rule exceptions are not included in rule exports or imports. Use the Import value lists UI (Manage → Rules → Import value lists) to export and import value lists separately.
To export and import detection rules:
- Go to Manage → Rules.
To export rules:
- In the rules table, select the rules you want to export.
- Select Bulk actions → Export, then save the exported file.
To import rules:
To import rules with actions, you need at least
Readprivileges for the
Action and Connectorsfeature. To overwrite or add new connectors, you need
Allprivileges for the
Actions and Connectorsfeature. To import rules without actions, you don’t need
Actions and Connectorsprivileges. Refer to Enable and access detections for more information.
- Click Import rules.
Drag and drop the file that contains the detection rules.
Imported rules must be in an
(Optional) Select Overwrite existing detection rules with conflicting "rule_id" to update existing rules if they match the
rule_idvalue of any rules in the import file. Configuration data included with the rules, such as actions, is also overwritten.
(Optional) Select Overwrite existing exception lists with conflicting "list_id" to replace existing exception lists with exception lists from the import file if they have a matching
(Optional) Select Overwrite existing connectors with conflicting action "id" to update existing connectors if they match the
action idvalue of any rule actions in the import file. Configuration data included with the actions is also overwritten.
- Click Import rule.
- (Optional) If a connector is missing sensitive information after the import, a warning displays and you’re prompted to fix the connector. In the warning, click Go to connector. On the Connectors page, find the connector that needs to be updated, click Fix, then add the necessary details.
Tutorial: Enable detection rulesedit
To learn how to enable detection rules in Elastic Security, watch the following tutorial.
Intro to Kibana
ELK for Logs & Metrics