--- type: api title: Security lists description: Lists can be used with detection rule exceptions to define values that prevent a rule from generating alerts. url: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/group/endpoint-security-lists-api resource: https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/group/endpoint-security-lists-api products: - Kibana --- # Security lists `Security Lists API` Lists can be used with detection rule exceptions to define values that prevent a rule from generating alerts. Lists are made up of: * **List containers**: A container for values of the same Elasticsearch data type. The following data types can be used: * `boolean` * `byte` * `date` * `date_nanos` * `date_range` * `double` * `double_range` * `float` * `float_range` * `half_float` * `integer` * `integer_range` * `ip` * `ip_range` * `keyword` * `long` * `long_range` * `short` * `text` * **List items**: The values used to determine whether the exception prevents an alert from being generated. All list items in the same list container must be of the same data type, and each item defines a single value. For example, an IP list container named `internal-ip-addresses-southport` contains five items, where each item defines one internal IP address: 1. `192.168.1.1` 2. `192.168.1.3` 3. `192.168.1.18` 4. `192.168.1.12` 5. `192.168.1.7` To use these IP addresses as values for defining rule exceptions, use the Security exceptions API to [create an exception list item](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-createexceptionlistitem) that references the `internal-ip-addresses-southport` list. > info > Lists cannot be added directly to rules, nor do they define the operators used to determine when exceptions are applied (`is in list`, `is not in list`). Use an exception item to define the operator and associate it with an [exception container](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-createexceptionlist). You can then add the exception container to a rule's `exceptions_list` object. ## Lists requirements Before you can start using lists, you must create the `.lists` and `.items` data streams for the relevant Kibana space. To do this, use the [Create list data streams](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-createlistindex) endpoint. Once these data streams are created, your role needs privileges to manage rules. Refer to [Enable and access detections](https://www.elastic.co/guide/en/security/current/detections-permissions-section.html#enable-detections-ui) for a complete list of requirements. - [Delete a value list](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-deletelist): `DELETE` `/api/lists`, `DELETE` `/s/{space_id}/api/lists` - [Get value list details](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-readlist): `GET` `/api/lists`, `GET` `/s/{space_id}/api/lists` - [Patch a value list](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-patchlist): `PATCH` `/api/lists`, `PATCH` `/s/{space_id}/api/lists` - [Create a value list](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-createlist): `POST` `/api/lists`, `POST` `/s/{space_id}/api/lists` - [Update a value list](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-updatelist): `PUT` `/api/lists`, `PUT` `/s/{space_id}/api/lists` - [Get value lists](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-findlists): `GET` `/api/lists/_find`, `GET` `/s/{space_id}/api/lists/_find` - [Delete value list data streams](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-deletelistindex): `DELETE` `/api/lists/index`, `DELETE` `/s/{space_id}/api/lists/index` - [Get status of value list data streams](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-readlistindex): `GET` `/api/lists/index`, `GET` `/s/{space_id}/api/lists/index` - [Create list data streams](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-createlistindex): `POST` `/api/lists/index`, `POST` `/s/{space_id}/api/lists/index` - [Delete a value list item](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-deletelistitem): `DELETE` `/api/lists/items`, `DELETE` `/s/{space_id}/api/lists/items` - [Get a value list item](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-readlistitem): `GET` `/api/lists/items`, `GET` `/s/{space_id}/api/lists/items` - [Patch a value list item](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-patchlistitem): `PATCH` `/api/lists/items`, `PATCH` `/s/{space_id}/api/lists/items` - [Create a value list item](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-createlistitem): `POST` `/api/lists/items`, `POST` `/s/{space_id}/api/lists/items` - [Update a value list item](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-updatelistitem): `PUT` `/api/lists/items`, `PUT` `/s/{space_id}/api/lists/items` - [Export value list items](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-exportlistitems): `POST` `/api/lists/items/_export`, `POST` `/s/{space_id}/api/lists/items/_export` - [Get value list items](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-findlistitems): `GET` `/api/lists/items/_find`, `GET` `/s/{space_id}/api/lists/items/_find` - [Import value list items](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-importlistitems): `POST` `/api/lists/items/_import`, `POST` `/s/{space_id}/api/lists/items/_import` - [Get value list privileges](https://www.elastic.co/elastic/docs-builder/docs/4371/api/doc/kibana/operation/operation-readlistprivileges): `GET` `/api/lists/privileges`, `GET` `/s/{space_id}/api/lists/privileges`