Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.74 KB

put.asciidoc

File metadata and controls

50 lines (34 loc) · 1.74 KB
Raw

Update Space

experimental[This API is experimental and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.]

Updates an existing {kib} space. To create a new space, use the POST command.

Request

To update a space, issue a PUT request to the /api/spaces/space/<space_id> endpoint.

PUT /api/spaces/space/<space_id>

Request Body

The following parameters can be specified in the body of a PUT request to update a space:

id

(string) Required identifier for the space. This identifier becomes part of Kibana’s URL when inside the space. This cannot be changed by the update operation.

name

(string) Required display name for the space.

description

(string) Optional description for the space.

initials

(string) Optionally specify the initials shown in the Space Avatar for this space. By default, the initials will be automatically generated from the space name. If specified, initials should be either 1 or 2 characters.

color

(string) Optioanlly specify the hex color code used in the Space Avatar for this space. By default, the color will be automatically generated from the space name.

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

Response

A successful call returns a response code of 200 with the updated Space.