Query parameters
-
id string(nonempty)
Value list item identifier. Required if
list_id
andvalue
are not specified.Minimum length is
1
. -
list_id string(nonempty)
Value list item list's
id
identfier. Required ifid
is not specified.Minimum length is
1
. -
value string
The value used to evaluate exceptions. Required if
id
is not specified.
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
GET
/api/lists/items
curl \
--request GET https://localhost:5601/api/lists/items
Response examples (200)
{
"id": "qN1XRJQBs4HAK3VQs3Gc",
"type": "ip",
"value": "127.0.0.2",
"list_id": "ip_list",
"_version": "WzExLDFd",
"@timestamp": "2025-01-08T05:16:25.882Z",
"created_at": "2025-01-08T05:16:25.882Z",
"created_by": "elastic",
"updated_at": "2025-01-08T05:16:25.882Z",
"updated_by": "elastic",
"tie_breaker_id": "a9a34c02-a385-436e-86a0-02a3942f3537"
}
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 [GET /api/lists/items?id=qN1XRJQBs4HAK3VQs3Gc] is unauthorized for user, this action is granted by the Kibana privileges [lists-read]",
"statusCode": 403
}
Response examples (404)
{
"message": "list item id: \\\"foo\\\" not found",
"status_code": 404
}
Response examples (500)
{
"message": "Internal Server Error",
"status_code": 500
}