IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Get Space

edit

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

Get 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.

Retrieves all Kibana spaces, or a specific space.

Get all Kibana spaces

edit

Request

edit

To retrieve all spaces, issue a GET request to the /api/spaces/space endpoint.

GET /api/spaces/space

Response

edit

A successful call returns a response code of 200 and a response body containing a JSON representation of the spaces.

[
  {
    "id": "default",
    "name": "Default",
    "description" : "This is the Default Space",
    "_reserved": true
  },
  {
    "id": "marketing",
    "name": "Marketing",
    "description" : "This is the Marketing Space",
    "color": "#aabbcc",
    "initials": "MK"
  },
  {
    "id": "sales",
    "name": "Sales",
    "initials": "MK"
  },
]

Get a specific space

edit

Request

edit

To retrieve a specific space, issue a GET request to the /api/spaces/space/<space_id> endpoint:

GET /api/spaces/space/marketing

Response

edit

A successful call returns a response code of 200 and a response body containing a JSON representation of the space.

{
  "id": "marketing",
  "name": "Marketing",
  "description" : "This is the Marketing Space",
  "color": "#aabbcc",
  "initials": "MK"
}

« Update Space Delete space »