查找异常容器

编辑

检索异常容器的分页子集。默认情况下,将返回第一页,每页 20 个结果。

请求 URL

编辑

GET <kibana 主机>:<端口>/api/exception_lists/_find

URL 查询参数

编辑

所有参数都是可选的

名称 类型 描述

page

整数

要返回的页码。

per_page

整数

每页要返回的容器数量。

sort_field

字符串

确定用于对结果排序的字段。

sort_order

字符串

确定排序顺序,可以是 descasc

cursor

字符串

返回在先前调用中返回的最后一个容器之后的容器(使用先前调用中返回的 cursor 值)。此参数使用 tie_breaker_id 字段来确保所有容器都正确排序和返回。有关更多信息,请参阅 Search After

namespace_type

字符串

确定返回的容器是与 Kibana 空间关联的 Kibana 还是在所有空间中可用(agnosticsingle)。

filter

字符串

根据指定字段的值过滤返回的结果。

使用 so type.field name:field value 语法,其中 so type 可以是

  • exception-list:指定一个空间感知的异常列表。
  • exception-list-agnostic:指定一个在空间之间共享的异常列表。

并且 field name 可以是

  • name
  • type
  • created_by
  • updated_by

search

字符串

根据 简单查询 过滤器过滤返回的结果。

示例请求

编辑

返回容器,按 name 降序排序

GET api/exception_lists/_find?page=1&per_page=2&sort_field=name&sort_order=desc

响应代码

编辑
200
表示调用成功。

响应负载

编辑
{
  "data": [
    {
      "_tags": [],
      "created_at": "2020-07-14T10:47:03.421Z",
      "created_by": "elastic",
      "description": "Trusted external IPs",
      "id": "5a7f77b0-c5bf-11ea-a3d8-a5b753aeeb9e",
      "list_id": "allowed-IPs",
      "name": "Trusted ext IPs",
      "namespace_type": "single",
      "tags": [
        "network",
        "IP"
      ],
      "tie_breaker_id": "5b39e2f4-bcfa-4199-bcf0-b859c4b805f4",
      "type": "detection",
      "updated_at": "2020-07-14T10:47:03.595Z",
      "updated_by": "elastic"
    },
    {
      "_tags": [],
      "created_at": "2020-07-14T08:24:22.884Z",
      "created_by": "elastic",
      "description": "Excludes trusted processes",
      "id": "6c03f6a0-c5ab-11ea-a3d8-a5b753aeeb9e",
      "list_id": "allowed-processes",
      "name": "Process exceptions",
      "namespace_type": "single",
      "tags": [
        "hosts",
        "processes"
      ],
      "tie_breaker_id": "65e16c8a-0d45-4e38-8a8f-094658a5df90",
      "type": "detection",
      "updated_at": "2020-07-14T08:24:23.050Z",
      "updated_by": "elastic"
    }
  ],
  "page": 1,
  "per_page": 2,
  "total": 6
}