Update space APIedit

Updates an existing Kibana space.

Warning

The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental.

Requestedit

PUT /api/spaces/space/<space_id>

Request bodyedit

id
(Required, string) The space ID that is part of the Kibana URL when inside the space. You are unable to change the ID with the update operation.
name
(Required, string) The display name for the space.
description
(Optional, string) The description for the space.
disabledFeatures
(Optional, string array) The list of disabled features for the space. To get a list of available feature IDs, use the Features API.
initials
(Optional, string) Specifies the initials shown in the space avatar. By default, the initials are automatically generated from the space name. Initials must be 1 or 2 characters.
color
(Optional, string) Specifies the hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.

Response codesedit

200
Indicates a successful call.

Exampleedit

PUT /api/spaces/space/marketing
{
  "id": "marketing",
  "name": "Marketing",
  "description" : "This is the Marketing Space",
  "color": "#aabbcc",
  "initials": "MK",
  "disabledFeatures": []
}