通过 ID 编辑参数 API

编辑

编辑具有指定 ID 的参数。

请求

编辑

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

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

先决条件

编辑

您必须在 可观测性 部分的 Synthetics 功能中拥有 all 权限,请参阅 Kibana 功能权限

路径参数

编辑
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"]
}