Update a space
Headers
-
elastic-api-version string
The version of the API to use
Value is
2023-10-31
. Default value is2023-10-31
. -
A required header to protect against CSRF attacks
Path parameters
-
The space identifier. You are unable to change the ID with the update operation.
Body
-
_reserved boolean
-
color string
The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.
-
description string
A description for the space.
-
disabledFeatures array[string]
The list of features that are turned off in the space.
Default value is
[]
(empty). -
The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, _, and -). You are cannot change the ID with the update operation.
-
imageUrl string
The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images.
-
initials string
One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.
Maximum length is
2
. -
The display name for the space.
Minimum length is
1
. -
solution string
Values are
security
,oblt
,es
, orclassic
.
curl \
-X PUT https://localhost:5601/api/spaces/space/{id} \
-H "Content-Type: application/json; Elastic-Api-Version=2023-10-31" \
-H "elastic-api-version: 2023-10-31" \
-H "kbn-xsrf: true"
{
"id": "marketing",
"name": "Marketing",
"color": null,
"imageUrl": "",
"initials": "MK",
"description": "This is the Marketing Space",
"disabledFeatures": []
}