更新设置 API

编辑

更新 uptime 设置属性,例如 heartbeatIndices、certExpirationThreshold、certAgeThreshold、defaultConnectors 或 defaultEmail

请求

编辑

PUT <kibana 主机>:<端口>/api/uptime/settings

PUT <kibana 主机>:<端口>/s/<空间 ID>/api/uptime/settings

先决条件

编辑

您必须在 Observability 部分的 Kibana 功能权限中拥有 uptime 功能的 all 权限。

路径参数

编辑
space_id
(可选,字符串)空间的标识符。 如果 URL 中未提供 space_id,则使用默认空间。

请求正文

编辑

支持部分更新,提供的设置键将与现有设置合并。

heartbeatIndices
(可选,字符串)在 uptime 应用程序/警报中用于查询 heartbeat 数据的索引模式字符串。默认为 heartbeat-*
certExpirationThreshold
(可选,数字)证书过期前触发警报的天数。默认为 30
certAgeThreshold
(可选,数字)证书创建后触发警报的天数。默认为 730
defaultConnectors
(可选,数组)用作新警报默认连接器的连接器 ID 列表。默认为 []
defaultEmail
(可选,对象)新警报的默认电子邮件配置。默认为 {"to": [], "cc": [], "bcc": []}

示例

编辑
PUT api/uptime/settings
{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}

API 返回以下内容

{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}

部分更新示例

编辑
PUT api/uptime/settings
{
    "heartbeatIndices": "heartbeat-8*",
}

API 返回以下内容

{
    "heartbeatIndices": "heartbeat-8*",
    "certExpirationThreshold": 30,
    "certAgeThreshold": 730,
    "defaultConnectors": [
        "08990f40-09c5-11ee-97ae-912b222b13d4",
        "db25f830-2318-11ee-9391-6b0c030836d6"
    ],
    "defaultEmail": {
        "to": [],
        "cc": [],
        "bcc": []
    }
}