更新空间 API
编辑更新空间 API编辑
[预览] 此功能处于技术预览阶段,可能会在将来的版本中更改或删除。Elastic 将努力解决任何问题,但技术预览中的功能不受官方 GA 功能的支持 SLA 约束。 更新现有的 Kibana 空间。
请求编辑
PUT <kibana 主机>:<端口>/api/spaces/space/<空间 ID>
请求正文编辑
-
id
- (必填,字符串) 空间 ID,它是空间内部 Kibana URL 的一部分。您无法使用更新操作更改 ID。
-
name
- (必填,字符串) 空间的显示名称。
-
description
- (可选,字符串) 空间的描述。
-
disabledFeatures
- (可选,字符串数组) 空间中禁用的功能列表。要获取可用功能 ID 列表,请使用 功能 API。
-
initials
- (可选,字符串) 指定在空间头像中显示的首字母。默认情况下,首字母会从空间名称自动生成。首字母必须是 1 或 2 个字符。
-
color
- (可选,字符串) 指定空间头像中使用的十六进制颜色代码。默认情况下,颜色会从空间名称自动生成。
-
imageUrl
- (可选,字符串) 指定在空间头像中显示的数据 URL 编码图像。如果指定,
initials
不会显示,并且color
将作为透明图像的背景颜色显示。为了获得最佳效果,您的图像应为 64x64。此 API 调用不会优化图像,因此在使用自定义图像时应谨慎。
响应代码编辑
-
200
- 表示调用成功。
示例编辑
$ curl -X PUT api/spaces/space/marketing { "id": "marketing", "name": "Marketing", "description" : "This is the Marketing Space", "color": "#aabbcc", "initials": "MK", "disabledFeatures": [], "imageUrl": "" }