This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
« Rule exceptions Add and manage exceptions »
Elastic Docs ›Elastic Security Solution [master] ›Detections and alerts ›Rule exceptions

Create and manage value lists

edit

Create and manage value lists

edit

Value lists hold multiple values of the same Elasticsearch data type, such as IP addresses, which are used to determine when an exception prevents an alert from being generated. You can use value lists to define exceptions for detection rules; however, you cannot use value lists to define endpoint rule exceptions.

Value lists are lists of items with the same Elasticsearch data type. You can create value lists with these types:

  • Keywords (many ECS fields are keywords)
  • IP Addresses
  • IP Ranges
  • Text

After creating value lists, you can use is in list and is not in list operators to define exceptions.

You can also use a value list as the indicator match index when creating an indicator match rule.

Create value lists

edit

When you create a value list for a rule exception, be mindful of the list’s size and data type. All rule types support value list exceptions, but extremely large lists or certain data types have limitations.

Custom query, machine learning, and indicator match rules support the following value list types and sizes:

  • Keywords or IP addresses list types with more than 65,536 values
  • IP ranges list type with over 200 dash notation values (for example, 127.0.0.1-127.0.0.4 is one value) or more than 65,536 CIDR notation values

To create a value list:

  1. Prepare a txt or csv file with all the values you want to use for determining exceptions from a single list. If you use a txt file, new lines act as delimiters.

    • All values in the file must be of the same Elasticsearch type.
    • Wildcards are not supported in value lists. Values must be literal values.
    • The maximum accepted file size is 9 million bytes.
  2. Find Detection rules (SIEM) in the navigation menu or by using the global search field.

  3. Click Manage value lists. The Manage value lists window opens.

    Manage value lists flyout
  4. Select the list type (Keywords, IP addresses, IP ranges, or Text) from the Type of value list drop-down.
  5. Drag or select the csv or txt file that contains the values.
  6. Click Import value list.

If you import a file with a name that already exists, a new list is not created. The imported values are added to the existing list instead.

Manage value lists

edit

You can edit, remove, or export existing value lists.

Edit value lists
edit
  1. Find Detection rules (SIEM) in the navigation menu or by using the global search field.
  2. Click Manage value lists. The Manage value lists window opens.
  3. In the Value lists table, click the value list you want to edit.

  4. Do any of the following:

    • Filter items in the list: Use the KQL search bar to find values in the list. Depending on your list’s type, you can filter by the keyword, ip_range, ip, or text fields. For example, to filter by Gmail addresses in a value list of the keyword type, enter keyword:*gmail.com into the search bar.

      You can also filter by the updated_by field (for example, updated_by:testuser), or the updated at field (for example, updated_at < now).

    • Add individual items to the list: Click Create list item, enter a value, then click Add list item.
    • Bulk upload list items: Drag or select the csv or txt file that contains the values that you want to add, then click Upload.
    • Edit a value: In the Value column, go to the value you want to edit and click the Edit button (Edit button from Manage value lists window). When you’re done editing, click the Save button (Save button from Manage value lists window) to save your changes. Click the Cancel button (Cancel button from Manage value lists window) to revert your changes.
    • Remove a value: Click the Remove value button (Remove value list button from Manage value lists window) to delete a value from the list.
Manage items in a value lists

You can also edit value lists while creating and managing exceptions that use value lists.

Export or remove value lists
edit
  1. Find Detection rules (SIEM) in the navigation menu or by using the global search field.
  2. Click Manage value lists. The Manage value lists window opens.

  3. From the Value lists table, you can:

    1. Click the Export value list button (Export button from Manage value lists window) to export the value list.

    2. Click the Remove value list button (Remove button from Manage value lists window) to delete the value list.

      Import value list flyout with action buttons highlighted
« Rule exceptions Add and manage exceptions »