Delete a value list item
Delete a value list item using its id
, or its list_id
and value
fields.
Query parameters
-
id string(nonempty)
Value list item's identifier. Required if
list_id
andvalue
are not specified.Minimum length is
1
. -
list_id string(nonempty)
Value list's identifier. Required if
id
is not specified.Minimum length is
1
. -
value string
The value used to evaluate exceptions. Required if
id
is not specified. -
refresh string
Determines when changes made by the request are made visible to search.
Values are
true
,false
, orwait_for
. Default value isfalse
.
Responses
-
200 application/json
Successful response
-
400 application/json
Invalid input data response
-
401 application/json
Unsuccessful authentication response
-
403 application/json
Not enough privileges response
-
404 application/json
List item not found response
-
500 application/json
Internal server error response
DELETE
/api/lists/items
curl \
--request DELETE https://localhost:5601/api/lists/items
Response examples (200)
{
"id": "pd1WRJQBs4HAK3VQeHFI",
"type": "ip",
"value": "255.255.255.255",
"list_id": "ip_list",
"_version": "WzIwLDFd",
"@timestamp": "2025-01-08T05:15:05.159Z",
"created_at": "2025-01-08T05:15:05.159Z",
"created_by": "elastic",
"updated_at": "2025-01-08T05:44:14.009Z",
"updated_by": "elastic",
"tie_breaker_id": "eee41dc7-1666-4876-982f-8b0f7b59eca3"
}
Response examples (400)
{
"message": "Either \\\"list_id\\\" or \\\"id\\\" needs to be defined in the request",
"status_code": 400
}
Response examples (401)
{
"error": "Unauthorized",
"message": "[security_exception\\n\\tRoot causes:\\n\\t\\tsecurity_exception: unable to authenticate user [elastic] for REST request [/_security/_authenticate]]: unable to authenticate user [elastic] for REST request [/_security/_authenticate]",
"statusCode": 401
}
Response examples (403)
{
"error": "Forbidden",
"message": "API [DELETE /api/lists/items?id=pd1WRJQBs4HAK3VQeHFI] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
"statusCode": 403
}
Response examples (404)
{
"message": "list item with id: \\\"pd1WRJQBs4HAK3VQeHFI\\\" not found",
"status_code": 404
}
Response examples (500)
{
"message": "Internal Server Error",
"status_code": 500
}