925dfab588
* Clean up * Dashboard export API * More changes * role-management and saved-objects * Clean up * Final clean up * Clean up * Moved labels to appropriate places * Fixed rogue commits
58 lines
1.6 KiB
Text
58 lines
1.6 KiB
Text
[[spaces-api-post]]
|
|
=== Create space API
|
|
++++
|
|
<titleabbrev>Create space</titleabbrev>
|
|
++++
|
|
|
|
Creates a {kib} space.
|
|
|
|
experimental[This functionality is *experimental* and may be changed or removed completely in a future release.]
|
|
|
|
[[spaces-api-post-request]]
|
|
==== Request
|
|
|
|
`POST /api/spaces/space`
|
|
|
|
[[spaces-api-post-request-body]]
|
|
==== Request body
|
|
|
|
`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-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.
|
|
|
|
[[spaces-api-post-response-codes]]
|
|
==== Response codes
|
|
|
|
`200`::
|
|
Indicates a successful call.
|
|
|
|
[[spaces-api-post-example]]
|
|
==== Example
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
POST /api/spaces/space
|
|
{
|
|
"id": "marketing",
|
|
"name": "Marketing",
|
|
"description" : "This is the Marketing Space",
|
|
"color": "#aabbcc",
|
|
"initials": "MK",
|
|
"disabledFeatures": ["timelion"]
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|