59 lines
No EOL
1.6 KiB
Text
59 lines
No EOL
1.6 KiB
Text
[[spaces-api-disable-legacy-url-aliases]]
|
|
=== Disable legacy URL aliases API
|
|
++++
|
|
<titleabbrev>Disable legacy URL aliases</titleabbrev>
|
|
++++
|
|
|
|
experimental[] Disable a <<legacy-url-aliases,legacy URL alias>> in {kib}.
|
|
|
|
[[spaces-api-disable-legacy-url-aliases-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST <kibana host>:<port>/api/spaces/_disable_legacy_url_aliases`
|
|
|
|
[role="child_attributes"]
|
|
[[spaces-api-disable-legacy-url-aliases-request-body]]
|
|
==== {api-request-body-title}
|
|
|
|
`aliases`::
|
|
(Required, object array) The aliases to disable.
|
|
+
|
|
.Properties of `aliases`
|
|
[%collapsible%open]
|
|
=====
|
|
`targetSpace`:::
|
|
(Required, string) The space where the alias target object exists.
|
|
|
|
`targetType`:::
|
|
(Required, string) The type of the alias target object.
|
|
|
|
`sourceId`:::
|
|
(Required, string) The ID of the alias source object. This is the "legacy" object ID.
|
|
=====
|
|
|
|
[[spaces-api-disable-legacy-url-aliases-response-codes]]
|
|
==== {api-response-codes-title}
|
|
|
|
`204`::
|
|
Indicates a successful call.
|
|
|
|
[[spaces-api-disable-legacy-url-aliases-example]]
|
|
==== {api-examples-title}
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
$ curl -X POST api/spaces/_disable_legacy_url_aliases
|
|
{
|
|
"aliases": [
|
|
{
|
|
"targetSpace": "bills-space",
|
|
"targetType": "dashboard",
|
|
"sourceId": "123"
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// KIBANA
|
|
|
|
This example 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. |