New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Kibana Spaces API Update Space »
Elastic Docs ›Kibana Guide [7.0] ›REST API ›Kibana Spaces API

Create Space

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Create Space

edit

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.

Creates a new Kibana space. To update an existing space, use the PUT command.

Note: You cannot access this endpoint via the Console in Kibana.

Request

edit

To create a space, issue a POST request to the /api/spaces/space endpoint.

POST /api/spaces/space

Request Body

edit

The following parameters can be specified in the body of a POST request to create 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) Optionally 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

edit
POST /api/spaces/space
{
  "id": "marketing",
  "name": "Marketing",
  "description" : "This is the Marketing Space",
  "color": "#aabbcc",
  "initials": "MK"
}
Copy as curl 

Response

edit

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

« Kibana Spaces API Update Space »

On this page

Was this helpful?
Feedback