Delete a value list Beta
Delete a value list using the list ID.
When you delete a list, all of its list items are also deleted.
Query parameters
-
Value list's identifier.
Minimum length is
1
. -
deleteReferences boolean
Determines whether exception items referencing this value list should be deleted.
Default value is
false
. -
ignoreReferences boolean
Determines whether to delete value list without performing any additional checks of where this list may be utilized.
Default value is
false
.
DELETE
/api/lists
curl \
--request DELETE https://<KIBANA_URL>/api/lists?id=21b01cfb-058d-44b9-838c-282be16c91cd
Response examples (200)
{
"id": "21b01cfb-058d-44b9-838c-282be16c91cd",
"name": "Bad ips",
"type": "ip",
"version": 3,
"_version": "WzIsMV0=",
"immutable": false,
"@timestamp": "2025-01-08T04:47:34.273Z",
"created_at": "2025-01-08T04:47:34.273Z",
"created_by": "elastic",
"updated_at": "2025-01-08T05:39:39.292Z",
"updated_by": "elastic",
"description": "List of bad internet ips.",
"tie_breaker_id": "f5508188-b1e9-4e6e-9662-d039a7d89899"
}
Response examples (400)
{
"error": "Bad Request",
"message": "[request query]: id: Required",
"statusCode": 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?id=ip_list] is unauthorized for user, this action is granted by the Kibana privileges [lists-all]",
"statusCode": 403
}
Response examples (404)
{
"message": "list id: \\\"ip_list\\\" was not found",
"status_code": 404
}
Response examples (500)
{
"message": "Internal Server Error",
"status_code": 500
}