Get Spaceedit

Warning

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

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

Get all Kibana spacesedit

Requestedit

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

GET /api/spaces/space
GET /api/spaces/space?purpose= copySavedObjectsIntoSpace

Request Query Parametersedit

purpose (optional)

Retrieve the available spaces for a specific purpose. This parameter only has an effect when security is enabled.

any (default)
Retrieves all spaces the user is authorized to access.
copySavedObjectsIntoSpace
Retrieves all spaces the user is authorized to copy saved objects into via Saved Objects Management.

Responseedit

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

If you are not authorized for any spaces for the provided purpose, then a response code of 403 will be returned.

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

Get a specific spaceedit

Requestedit

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

GET /api/spaces/space/marketing

Responseedit

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",
  "disabledFeatures": []
}