通过 ID 编辑参数 API编辑

编辑指定 ID 的参数。

请求编辑

PUT <kibana 主机>:<端口>/api/synthetics/params

PUT <kibana 主机>:<端口>/s/<空间 ID>/api/synthetics/params

先决条件编辑

您必须对 Kibana 功能权限可观察性 部分的 Synthetics 功能拥有 all 权限。

路径参数编辑

id
(必填,字符串) 要编辑的参数的唯一标识符。

请求正文编辑

请求正文应包含以下属性

key
(必填,字符串) 参数的键。
value
(必填,字符串) 与参数关联的更新值。
description
(可选,字符串) 参数的更新描述。
tags
(可选,字符串数组) 用于对参数进行分类的更新标签数组。

示例编辑

以下是一个通过 ID 编辑参数的 PUT 请求示例

PUT /api/synthetics/params/param_id1
{
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}

API 返回更新后的参数,如下所示

{
  "id": "param_id1",
  "key": "updated_param_key",
  "value": "updated-param-value",
  "description": "Updated Param to be used in browser monitor",
  "tags": ["authentication", "security", "updated"]
}