Update a space

Base URL: https://{kibana_url}

PUT /api/spaces/space/{id}

Authentication

Api key

Authorization: <value>

These APIs use key-based authentication. You must create an API key and use the encoded value in the request header. For example: Authorization: ApiKey base64AccessApiKey

Basic

Authorization: Basic <credentials>

Path parameters

Header parameters

Request body

Response

200

Indicates a successful call.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Update the marketing space to remove the imageUrl.

Console Kibana Dev Tools

PUT kbn:/api/spaces/space/ID
{
  "id": "marketing",
  "name": "Marketing",
  "description": "This is the Marketing Space",
  "color": "null",
  "initials": "MK",
  "disabledFeatures": [],
  "imageUrl": ""
}

Generated from the API spec

curl Shell

curl -X PUT "${KIBANA_URL}/api/spaces/space/${ID}" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "marketing",
    "name": "Marketing",
    "description": "This is the Marketing Space",
    "color": "null",
    "initials": "MK",
    "disabledFeatures": [],
    "imageUrl": ""
  }'

Generated from the API spec

Response

No body

Authentication

Path parameters

Header parameters

Request body { }

Response

Request body