1e3f14395c
* [DOCS] API intro * Logstash configuration management * Reformatting * Comments from Josh * Commets from Gail * Fixed broken things
64 lines
2 KiB
Plaintext
64 lines
2 KiB
Plaintext
[[spaces-api-put]]
|
|
=== Update space API
|
|
++++
|
|
<titleabbrev>Update space</titleabbrev>
|
|
++++
|
|
|
|
Update an existing {kib} space.
|
|
|
|
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
|
|
|
|
[[spaces-api-put-api-request]]
|
|
==== Request
|
|
|
|
`PUT /api/spaces/space/<space_id>`
|
|
|
|
[[spaces-api-put-request-body]]
|
|
==== Request body
|
|
|
|
`id`::
|
|
(Required, string) The space ID that is part of the {kib} 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-get, 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.
|
|
|
|
`imageUrl`::
|
|
(Optional, string) Specifies 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.
|
|
|
|
[[spaces-api-put-response-codes]]
|
|
==== Response codes
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
[[sample-api-example]]
|
|
==== Example
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
PUT /api/spaces/space/marketing
|
|
{
|
|
"id": "marketing",
|
|
"name": "Marketing",
|
|
"description" : "This is the Marketing Space",
|
|
"color": "#aabbcc",
|
|
"initials": "MK",
|
|
"disabledFeatures": [],
|
|
"imageUrl": ""
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|