GET /api/spaces/space/{id}
Api key auth Basic auth

Retrieve a single Kibana space by its identifier.

Path parameters

  • id string Required

    The space identifier.

Responses

  • 200 application/json

    Indicates a successful call.

    Hide response attributes Show response attributes object
    • _reserved boolean
    • color string

      The hexadecimal color code used in the space avatar. By default, the color is automatically generated from the space name.

    • description string

      A description for the space.

    • disabledFeatures array[string]

      The list of features that are turned off in the space.

      Not more than 100 elements. Default value is [] (empty).

    • id string Required

      The space ID that is part of the Kibana URL when inside the space. Space IDs are limited to lowercase alphanumeric, underscore, and hyphen characters (a-z, 0-9, _, and -). You are cannot change the ID with the update operation.

    • imageUrl string

      The data-URL encoded image to display in the space avatar. If specified, initials will not be displayed and the color will be visible as the background color for transparent images. For best results, your image should be 64x64. Images will not be optimized by this API call, so care should be taken when using custom images.

    • initials string

      One or two characters that are shown in the space avatar. By default, the initials are automatically generated from the space name.

      Maximum length is 2.

    • name string Required

      The display name for the space.

      Minimum length is 1.

    • projectRouting string

      Cross-project search default routing configuration for this space. Controls whether searches are scoped to a single project or span multiple projects in serverless environments.

    • solution string

      Values are security, oblt, es, or classic.
GET /api/spaces/space/{id} 
curl \
 --request GET 'https://localhost:5601/api/spaces/space/{id}' \
 --header "Authorization: $API_KEY"
Response examples (200)
A response that contains the full configuration for a single Kibana space. 
{
  "color": "#aabbcc",
  "description": "This is the Marketing Space",
  "disabledFeatures": [],
  "id": "marketing",
  "imageUrl": "",
  "initials": "MK",
  "name": "Marketing",
  "solution": "es"
}