Get all spaces

Base URL: https://{kibana_url}

GET /api/spaces/space

Auth

Retrieve all available Kibana spaces. The list includes only the spaces that the user is authorized to access.

Query parameters

purpose enum: Specifies which authorization checks are applied to the API call. The default value is any.; Values: any copySavedObjectsIntoSpace shareSavedObjectsIntoSpace
include_authorized_purposes boolean: When enabled, the API returns any spaces the user is authorized to access in any capacity, each including the purposes for which the user is authorized. This is useful for identifying spaces the user can read but is not authorized for a given purpose. Without the security plugin, this parameter has no effect, because no authorization checks are performed. This parameter cannot be used together with the purpose parameter.

Response

200

Indicates a successful call.

application/json

View as Markdown

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

GET kbn:/api/spaces/space

Generated from the API spec

curl Shell

curl -X GET "${KIBANA_URL}/api/spaces/space" \
  -H "Authorization: ApiKey ${API_KEY}"

Generated from the API spec

Response

Get all spaces without specifying any options.

[
  {
    "id": "default",
    "name": "Default",
    "description": "This is the Default Space",
    "disabledFeatures": [],
    "imageUrl": "",
    "_reserved": true
  },
  {
    "id": "marketing",
    "name": "Marketing",
    "description": "This is the Marketing Space",
    "color": "null",
    "disabledFeatures": [
      "apm"
    ],
    "initials": "MK",
    "imageUrl": "data:image/png;base64,iVBORw0KGgoAAAANSU"
  },
  {
    "id": "sales",
    "name": "Sales",
    "initials": "MK",
    "disabledFeatures": [
      "discover"
    ],
    "imageUr\u0022": "",
    "solution": "oblt"
  }
]