获取已保存查询 API

编辑

[预览] 此功能为技术预览版,可能会在未来的版本中更改或删除。Elastic 将努力修复任何问题,但技术预览版中的功能不受官方 GA 功能的支持 SLA 约束。 获取已保存的查询。

请求

编辑

GET <kibana 主机>:<端口>/api/osquery/saved_queries

GET <kibana 主机>:<端口>/s/<空间 ID>/api/osquery/saved_queries

路径参数

编辑
space_id
(可选,字符串)空间标识符。当 URL 中未提供 space_id 时,将使用默认空间。

查询参数

编辑
page
(可选,整数)要返回的页码。默认值为 1
pageSize
(可选,整数)每页返回的规则数量。默认值为 20
sort

(可选,字符串)指定对结果进行排序的字段。选项包括 createdAtupdatedAt。默认值为 createdAt

即使 JSON case 对象使用 created_atupdated_at 字段,也必须在 URL 查询中使用 createdAtupdatedAt 字段。

sortOrder
(可选,字符串)确定排序顺序。选项包括 descasc。默认值为 desc

响应代码

编辑
200
指示调用成功。

示例

编辑

检索前 10 个已保存的查询

$ curl -X GET api/osquery/saved-queries?page=1&perPage=10&sortField=updatedAt&sortOrder=asc

API 返回检索到的已保存查询的 JSON 对象

{
  "page": 1,
  "per_page": 100,
  "total": 11,
  "data": [
    {
      "type": "osquery-saved-query",
      "id": "42ba9c50-0cc5-11ed-aa1d-2b27890bc90d",
      "namespaces": ["default"],
      "attributes": {
        "id": "saved_query_id",
        "description": "Saved query description",
        "query": "select * from uptime;",
        "platform": "linux,darwin",
        "version": "2.8.0",
        "interval": "60",
        "ecs_mapping": {
          "host.uptime": {
            "field": "total_seconds"
          }
        },
        "created_by": "elastic",
        "created_at": "2022-07-26T09:28:08.597Z",
        "updated_by": "elastic",
        "updated_at": "2022-07-26T09:28:08.597Z",
        "prebuilt": false
      },
    },
    {...}
  ]
}