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.

« Delete list container Detection Alerts Migration API »

› › ›

Delete list item

edit

Delete list item

edit

Deletes list items.

Request URL

edit

DELETE <kibana host>:<port>/api/lists/items

URL query parameters

edit

Name	Type	Description	Required
`id`	String	Unique identifier of the list item.	Required if `list_id` and `value` are not specified.
`list_id`	String	Unique identifier of the list container.	Required if `id` is not specified.
`value`	String	The value used to evaluate exceptions. For information on how list item exceptions are evaluated, refer to Create exception item.	Required if `id` is not specified.
`refresh`	String	Determines when changes made by the request are made visible to search. Defaults to `false`. Valid values are: `true` `false`	Optional.

The URL query must include one of the following:

id - DELETE /api/lists/items?id=<id>
list_id and value - DELETE /api/lists/items?list_id=<list_id>&value=<value>

Example request

edit

Deletes the list item with an id of internal-ip-london:

DELETE api/lists/items?id=internal-ip-london

Deletes list items from an ip container using CIDR notation:

DELETE api/lists/items?list_id=internal-ip-excludes&value=127.0.0.0/30

Response code

edit

200: Indicates a successful call.

« Delete list container Detection Alerts Migration API »