获取包 API

编辑

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

请求

编辑

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

GET <kibana 主机>:<端口>/s/<空间_id>/api/osquery/packs

路径参数

编辑
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/packs?page=1&perPage=10&sortField=updatedAt&sortOrder=asc

API 返回一个带有检索到的包的 JSON 对象

{
  "page": 1,
  "per_page": 10,
  "total": 11,
  "data": [
    {
      "type": "osquery-pack",
      "id": "bbe5b070-0c51-11ed-b0f8-ad31b008e832",
      "namespaces": ["default"],
      "attributes": {
        "name": "test_pack",
        "queries": [
          {
            "query": "select * from uptime",
            "interval": 3600,
            "id": "uptime",
            "ecs_mapping": [
              {
                "value": {
                  "field": "days"
                },
                "key": "message"
              }
            ]
          }
        ],
        "enabled": true,
        "created_at": "2022-07-25T19:41:10.263Z",
        "created_by": "elastic",
        "updated_at": "2022-07-25T20:12:01.455Z",
        "updated_by": "elastic",
        "description": ""
      },
      "policy_ids": []
      },
      {...}
    ]
  }
}