Delete a list item Beta
Delete a list item using its id
, or its list_id
and value
fields.
Query parameters
-
id string(nonempty)
Required if
list_id
andvalue
are not specifiedMinimum length is
1
. -
list_id string(nonempty)
Required if
id
is not specifiedMinimum length is
1
. -
value string
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; Elastic-Api-Version=2023-10-31
Successful response
-
400 application/json; Elastic-Api-Version=2023-10-31
Invalid input data response
-
401 application/json; Elastic-Api-Version=2023-10-31
Unsuccessful authentication response
-
403 application/json; Elastic-Api-Version=2023-10-31
Not enough privileges response
-
404 application/json; Elastic-Api-Version=2023-10-31
List item not found response
-
500 application/json; Elastic-Api-Version=2023-10-31
Internal server error response
DELETE
/api/lists/items
curl \
-X DELETE https://<KIBANA_URL>/api/lists/items
Response examples (200)
Security_lists_api_listitem
{
"_version": "string",
"@timestamp": "2024-05-04T09:42:00+00:00",
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"deserializer": "string",
"id": "string",
"list_id": "string",
"meta": {},
"serializer": "string",
"tie_breaker_id": "string",
"type": "binary",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string",
"value": "string"
}
[
{
"_version": "string",
"@timestamp": "2024-05-04T09:42:00+00:00",
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"deserializer": "string",
"id": "string",
"list_id": "string",
"meta": {},
"serializer": "string",
"tie_breaker_id": "string",
"type": "binary",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string",
"value": "string"
}
]
Response examples (400)
Security_lists_api_platformerrorresponse
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
Response examples (401)
{
"error": "string",
"message": "string",
"statusCode": 42
}
Response examples (403)
{
"error": "string",
"message": "string",
"statusCode": 42
}
Response examples (404)
{
"message": "string",
"status_code": 42
}
Response examples (500)
{
"message": "string",
"status_code": 42
}