Export detection rules
Spaces method and path for this operation:
<div><span class="operation-verb post">post</span> <span class="operation-path">/s/{space_id}/api/detection_engine/rules/_export</span></div>Refer to Spaces for more information.
Export detection rules to an .ndjson file. The following configuration items are also included in the .ndjson file:
- Actions
- Exception lists
info 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 use Kibana’s Saved Objects UI (Stack Management → Kibana → Saved Objects) or the Saved Objects APIs (experimental) to export and import any necessary connectors before importing detection rules.
Similarly, any value lists used for rule exceptions are not included in rule exports or imports. Use the Manage value lists UI (Rules → Detection rules (SIEM) → Manage value lists) to export and import value lists separately.
Query parameters
Determines whether a summary of the exported rules is returned.
File name for saving the exported rules.
info When using cURL to export rules to a file, use the -O and -J options to save the rules to the file name specified in the URL.
Request body
Response
Indicates a successful call.