Delete a value list

Server: https://{kibana_url}

DELETE /api/lists

Api key auth Basic auth

Delete a value list using the list ID.

info When you delete a list, all of its list items are also deleted.

Query Parameters

Responses

Successful response

application/json

Invalid input data response

application/json

Unsuccessful authentication response

application/json

Not enough privileges response

application/json

List not found response

application/json

Internal server error response

application/json

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

DELETE /api/lists?id={id}

curl Shell

curl -X DELETE "https://{kibana_url}/api/lists?id={id}"

Response

{
  "_version": "WzIsMV0=",
  "@timestamp": "2025-01-08T04:47:34.273Z",
  "created_at": "2025-01-08T04:47:34.273Z",
  "created_by": "elastic",
  "description": "List of bad internet ips.",
  "id": "21b01cfb-058d-44b9-838c-282be16c91cd",
  "immutable": false,
  "name": "Bad ips",
  "tie_breaker_id": "f5508188-b1e9-4e6e-9662-d039a7d89899",
  "type": "ip",
  "updated_at": "2025-01-08T05:39:39.292Z",
  "updated_by": "elastic",
  "version": 3
}

{
  "error": "Bad Request",
  "message": "[request query]: id: Required",
  "statusCode": 400
}

{
  "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
}

{
  "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
}

{
  "message": "list id: \\\u0022ip_list\\\u0022 was not found",
  "status_code": 404
}

{
  "message": "Internal Server Error",
  "status_code": 500
}

Query Parameters { id , deleteReferences , ignoreReferences , }

Responses

Query Parameters