Get exception list items Beta
Get a list of all exception list items in the specified list.
Query parameters
-
List's id
Minimum length of each is
1
. Format of each should match the following pattern:^(?! *$).+$
. -
filter array[string]
Filters the returned results according to the value of the specified field, using the
<field name>:<field value>
syntax.Minimum length of each is
1
. Format of each should match the following pattern:^(?! *$).+$
. Default value is[]
(empty). -
namespace_type array[string]
Determines whether the returned containers are Kibana associated with a Kibana space or available in all spaces (
agnostic
orsingle
)Values are
agnostic
orsingle
. Default value is["single"]
. -
search string
-
page integer
The page number to return
Minimum value is
0
. -
per_page integer
The number of exception list items to return per page
Minimum value is
0
. -
sort_field string
Determines which field is used to sort the results
Minimum length is
1
. Format should match the following pattern:^(?! *$).+$
. -
sort_order string
Determines the sort order, which can be
desc
orasc
Values are
desc
orasc
.
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
Exception list not found response
-
500 application/json; Elastic-Api-Version=2023-10-31
Internal server error response
curl \
-X GET https://<KIBANA_URL>/api/exception_lists/items/_find?list_id=string
{
"data": [
{
"_version": "string",
"comments": [
{
"comment": "string",
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"id": "string",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string"
}
],
"created_at": "2024-05-04T09:42:00+00:00",
"created_by": "string",
"description": "string",
"entries": [
{
"field": "string",
"operator": "excluded",
"type": "match",
"value": "string"
}
],
"expire_time": "2024-05-04T09:42:00+00:00",
"id": "string",
"item_id": "string",
"list_id": "string",
"meta": {},
"name": "string",
"namespace_type": "single",
"os_types": [],
"tags": [],
"tie_breaker_id": "string",
"type": "simple",
"updated_at": "2024-05-04T09:42:00+00:00",
"updated_by": "string"
}
],
"page": 42,
"per_page": 42,
"pit": "string",
"total": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"error": "string",
"message": "string",
"statusCode": 42
}
{
"message": "string",
"status_code": 42
}
{
"message": "string",
"status_code": 42
}