Open and manage cases
editOpen and manage cases
editYou can create and manage cases using the UI or the Cases API.
Open a new case
editOpen a new case to keep track of security issues and share their details with colleagues.
- Go to Cases, then click Create case. If no cases exist, the Cases table will be empty and you’ll be prompted to create one by clicking the Create case button inside the table.
-
Give the case a name, assign a severity level, and provide a description. You can use Markdown syntax in the case description.
If you do not assign your case a severity level, it will be assigned Low by default.
You can insert a Timeline link in the case description by clicking the Timeline icon (
). - Optionally, add a category, assignees and relevant tags. You can add users only if they meet the necessary prerequisites.
- Choose if you want alert statuses to sync with the case’s status after they are added to the case. This option is enabled by default, but you can turn it off after creating the case.
-
From External incident management, select a connector. If you’ve previously added one, that connector displays as the default selection. Otherwise, the default setting is
No connector selected. -
Click Create case.
If you’ve selected a connector for the case, the case is automatically pushed to the third-party system it’s connected to.
Add custom fields
editThis functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
You can add optional and required fields for customized case collaboration.
-
Go to Cases and click Settings.
To view and change case settings, you must have the appropriate Kibana feature privileges. Refer to Cases prerequisites.
-
In the Custom fields section, click Add field.
- Enter a field label.
- Choose a field type: text or toggle.
- (Optional) To make the text field mandatory, select Make this field required.
- (Optional) Add a default value.
- Click Save field.
After you create custom fields, they’re added to all new and existing cases. Existing cases have null values for the new text fields until you set them. To manage custom fields, go to the Settings page and remove or edit them.
Add email notifications
editYou can configure email notifications that occur when users are assigned to cases.
For hosted Kibana on Elasticsearch Service:
-
Add the email domains to the notifications domain allowlist.
You do not need to take any more steps to configure an email connector or update Kibana user settings, since the preconfigured Elastic-Cloud-SMTP connector is used by default.
For self-managed Kibana:
-
Create a preconfigured email connector.
At this time, email notifications support only preconfigured email connectors, which are defined in the
kibana.ymlfile. -
Set the
notifications.connectors.default.emailKibana setting to the name of your email connector. - If you want the email notifications to contain links back to the case, you must configure the server.publicBaseUrl setting.
When you subsequently add assignees to cases, they receive an email.
Manage existing cases
editFrom the Cases page, you can search existing cases and filter them by attributes such as assignees, categories, severity, status, and tags. You can also select multiple cases and use bulk actions to delete cases or change their attributes. General case metrics, including how long it takes to close cases, are provided above the table.
To explore a case, click on its name. You can then:
- Review the case summary
-
Comments can contain Markdown. For syntax help, click the Markdown icon (
) in the bottom right of the comment. - Examine alerts and indicators attached to the case
- Add files
- Add a Lens visualization
- Modify the case’s description, assignees, category, severity, status, and tags.
- Manage connectors and send updates to external systems (if you’ve added a connector to the case)
- Copy the case UUID
- Refresh the case to retrieve the latest updates
Review the case summary
editClick on an existing case to access its summary. The case summary, located under the case title, contains metrics that summarize alert information and response times. These metrics update when you attach additional unique alerts to the case, add connectors, or modify the case’s status:
- Total alerts: Total number of unique alerts attached to the case
- Associated users: Total number of unique users that are represented in the attached alerts
- Associated hosts: Total number of unique hosts that are represented in the attached alerts
- Total connectors: Total number of connectors that have been added to the case
- Case created: Date and time that the case was created
- Open duration: Time elapsed since the case was created
-
In progress duration: How long the case has been in the
In progressstate - Duration from creation to close: Time elapsed from when the case was created to when it was closed
Manage case comments
editTo edit, delete, or quote a comment, select the appropriate option from the More actions menu (…).
Examine alerts attached to a case
editTo explore the alerts attached to a case, click the Alerts tab. In the table, alerts are organized from oldest to newest. To view alert details, click the View details button.
Each case can have a maximum of 1,000 alerts.
Add files
editTo upload files to a case, click the Files tab:
You can set file types and sizes by configuring your Kibana case settings.
To download or delete the file, or copy the file hash to your clipboard, open the Actions menu (…). The available hash functions are MD5, SHA-1, and SHA-256.
When you add a file, a comment is added to the case activity log. To view an image, click its name in the activity or file list.
Add a Lens visualization
editThis functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.
Add a Lens visualization to your case to portray event and alert data through charts and graphs.
To add a Lens visualization to a comment within your case:
- Click the Visualization button. The Add visualization dialog appears.
-
Select an existing visualization from your Visualize Library or create a new visualization.
Set an absolute time range for your visualization. This ensures your visualization doesn’t change over time after you save it to your case, and provides important context for others managing the case.
-
Save the visualization to your Visualize Library by clicking the Save to library button (optional).
- Enter a title and description for the visualization.
- Choose if you want to keep the Update panel on Security activated. This option is activated by default and automatically adds the visualization to your Visualize Library.
- After you’ve finished creating your visualization, click Save and return to go back to your case.
- Click Preview to show how the visualization will appear in the case comment.
- Click Add Comment to add the visualization to your case.
Alternatively, while viewing a dashboard you can open a panel’s menu then click More actions (…) → Add to existing case or More actions (…) → Add to new case.
After a visualization has been added to a case, you can modify or interact with it by clicking the Open Visualization option in the case’s comment menu.
Copy the case UUID
editEach case has a universally unique identifier (UUID) that you can copy and share. To copy a case’s UUID to a clipboard, go to the Cases page and select Actions → Copy Case ID for the case you want to share. Alternatively, go to a case’s details page, then from the More actions menu (…), select Copy Case ID.
Export and import cases
editCases can be exported and imported as saved objects using the Kibana Saved Objects UI.
Before importing Lens visualizations, Timelines, or alerts into a space, ensure their data is present. Without it, they won’t work after being imported.
Export a case
editUse the Export option to move cases between different Kibana instances. When you export a case, the following data is exported to a newline-delimited JSON (.ndjson) file:
- Case details
- User actions
- Text string comments
- Case alerts
- Lens visualizations (exported as JSON blobs).
The following attachments are not exported:
- Case files: Case files are not exported. However, they are accessible in Stack Management > Files to download and re-add.
- Alerts: Alerts attached to cases are not exported. You must re-add them after importing cases.
To export a case:
- Open the main menu, go to Stack Management → Kibana, then select the Saved Objects tab.
- Search for the case by choosing a saved object type or entering the case title in the search bar.
- Select one or more cases, then click the Export button.
-
Click Export. A confirmation message that your file is downloading displays.
Keep the Include related objects option enabled to ensure connectors are exported too.
Import a case
editTo import a case:
- Open the main menu, go to Stack Management → Kibana, then select the Saved Objects tab.
- Click Import.
- Select the NDJSON file containing the exported case and configure the import options.
- Click Import.
-
Review the import log and click Done.
Be mindful of the following:
- If the imported case had connectors attached to it, you’ll be prompted to re-authenticate the connectors. To do so, click Go to connectors on the Import saved objects flyout and complete the necessary steps. Alternatively, open the main menu, then go to Stack Management → Connectors to access connectors.
- If the imported case had attached alerts, verify that the alerts' source documents exist in the environment. Case features that interact with alerts (such as the Alert details flyout and rule details page) rely on the alerts' source documents to function.