Query parameters
-
Value list's identifier.
Minimum length is
1
. -
page integer
The page number to return.
-
per_page integer
The number of list items to return per page.
-
sort_field string(nonempty)
Determines which field is used to sort the results.
Minimum length is
1
. -
sort_order string
Determines the sort order, which can be
desc
orasc
Values are
desc
orasc
. -
cursor string(nonempty)
Returns the items that come after the last item returned in the previous call (use the
cursor
value returned in the previous call). This parameter uses thetie_breaker_id
field to ensure all items are sorted and returned correctly.Minimum length is
1
. -
filter string
Filters the returned results according to the value of the specified field, using the : syntax.
GET
/api/lists/items/_find
curl \
--request GET https://localhost:5601/api/lists/items/_find?list_id=21b01cfb-058d-44b9-838c-282be16c91cd
Response examples (200)
{
"data": [
{
"id": "21b01cfb-058d-44b9-838c-282be16c91cc",
"type": "ip",
"value": "127.0.0.1",
"list_id": "ip_list",
"_version": "WzAsMV0=",
"@timestamp": "2025-01-08T04:59:06.154Z",
"created_at": "2025-01-08T04:59:06.154Z",
"created_by": "elastic",
"updated_at": "2025-01-08T04:59:06.154Z",
"updated_by": "elastic",
"tie_breaker_id": "b57c762c-3036-465c-9bfb-7bfb5e6e515a"
}
],
"page": 1,
"total": 1,
"cursor": "WzIwLFsiYjU3Yzc2MmMtMzAzNi00NjVjLTliZmItN2JmYjVlNmU1MTVhIl1d",
"per_page": 20
}
Response examples (400)
{
"error": "Bad Request,",
"message": "[request query]: list_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 [GET /api/lists/items/_find?list_id=ip_list&page=1&per_page=20] is unauthorized for user, this action is granted by the Kibana privileges [lists-read]",
"statusCode": 403
}
Response examples (500)
{
"message": "Internal Server Error",
"status_code": 500
}