Disable legacy URL aliases

Base URL: https://{kibana_url}

POST /api/spaces/_disable_legacy_url_aliases

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>

Response

204

Indicates a successful call.

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

This request leaves the alias intact but the legacy URL for this alias (http://localhost:5601/s/bills-space/app/dashboards#/view/123) will no longer function. The dashboard still exists and you can access it with the new URL.

Console Kibana Dev Tools

POST kbn:/api/spaces/_disable_legacy_url_aliases
{
  "aliases": [
    {
      "targetSpace": "bills-space",
      "targetType": "dashboard",
      "sourceId": 123
    }
  ]
}

Generated from the API spec

curl Shell

curl -X POST "${KIBANA_URL}/api/spaces/_disable_legacy_url_aliases" \
  -H "kbn-xsrf: true" \
  -H "Authorization: ApiKey ${API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "aliases": [
      {
        "targetSpace": "bills-space",
        "targetType": "dashboard",
        "sourceId": 123
      }
    ]
  }'

Generated from the API spec

Response

No body

Disable legacy URL aliases

Authentication

Header parameters

Request body

Response

Authentication

Header parameters

Request body { }

Response

Request body