› › ›

更新对象 API

更新对象 API编辑

将在未来版本中删除

更新现有 Kibana 保存对象的属性。

有关最新 API 详细信息，请参阅开放 API 规范。

PUT <kibana 主机>:<端口>/api/saved_objects/<类型>/<id>

PUT <kibana 主机>:<端口>/s/<空间 ID>/api/saved_objects/<类型>/<id>

space_id: (可选，字符串) 空间的标识符。如果 URL 中未提供 space_id，则使用默认空间。
type: (必需，字符串) 有效选项包括 visualization、dashboard、search、index-pattern、config。
id: (必需，字符串) 要更新的对象 ID。

attributes: (必需，对象) 要持久化的数据。

更新时，不会验证属性，这允许您将任意和格式错误的数据传递到 API 并破坏 Kibana。确保发送到 API 的任何数据都格式正确。
references: (可选，数组) 具有 name、id 和 type 属性的对象，描述此对象引用的其他保存对象。要引用其他保存对象，请在属性中使用 name，但不要使用 id，它会在迁移或导入/导出期间自动更新。
upsert: (可选，对象) 如果指定，则如果文档不存在，将使用给定的 upsert 属性创建文档。

更新现有数据视图对象 my-pattern，使用不同的标题

$ curl -X PUT api/index_patterns/index-pattern/my-pattern
{
  "attributes": {
    "title": "some-other-pattern-*"
  }
}

API 返回以下内容

{
  "id": "my-pattern",
  "type": "index-pattern",
  "version": 2,
  "attributes": {
    "title": "some-other-pattern-*"
  }
}

从 Kibana 8.0 开始，保存对象可以存在于多个空间中。因此，在使用 upsert 选项时，您可能会遇到 409 别名冲突 错误。更新 API 响应有限，不包含其他元数据。您可以使用批量创建 API 获取有关此错误的更多详细信息。