ELelastic
spaces

Update a space

Update an existing Kibana space.

put/api/spaces/space/{id}

Request

  • Base URL
    https://localhost:5601
  • URL
    https://localhost:5601/api/spaces/space/{id}
  • Auth
    • API key in header Authorization
    • or HTTP basic

Path parameters

idstring required

The space identifier. You are unable to change the ID with the update operation.

Headers

kbn-xsrfstring required
Example:true

A required header to protect against CSRF attacks

Request body

_reservedboolean
colorstring

The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.

descriptionstring

A description for the space.

disabledFeaturesstring[]
idstring required

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.

imageUrlstring

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.

initialsstring

One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.

namestring required

The display name for the space.

projectRoutingstring

Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.

solution'security' | 'oblt' | 'es' | 'classic'

Response

Indicates a successful call.

_reservedboolean
colorstring

The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.

descriptionstring

A description for the space.

disabledFeaturesstring[]
idstring required

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.

imageUrlstring

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.

initialsstring

One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.

namestring required

The display name for the space.

projectRoutingstring

Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.

solution'security' | 'oblt' | 'es' | 'classic'

Changes

No operation changes recorded.