mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
cfae69717a
PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index and data stream aliases. Previously, this anchor was used for our field alias documentation. Repurposing the anchor has caused continuity errors for users selecting different versions of the ES docs. It could also cause confusion for users with a `/current/` link to the `alias` page. This updates the anchor for the alias guide and adds a redirect page to disambiguate the `alias` anchor. It also fixes a bread crumb issue for redirects following the 'Modifying your Data' redirect page. Closes #77034.
54 lines
1.3 KiB
Text
54 lines
1.3 KiB
Text
[[indices-add-alias]]
|
|
=== Create or update alias API
|
|
++++
|
|
<titleabbrev>Create or update alias</titleabbrev>
|
|
++++
|
|
|
|
Adds a data stream or index to an <<aliases,alias>>.
|
|
|
|
[source,console]
|
|
----
|
|
PUT my-data-stream/_alias/my-alias
|
|
----
|
|
// TEST[setup:my_data_stream]
|
|
// TEST[teardown:data_stream_cleanup]
|
|
|
|
[[add-alias-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`POST <target>/_alias/<alias>`
|
|
|
|
`POST <target>/_aliases/<alias>`
|
|
|
|
`PUT <target>/_alias/<alias>`
|
|
|
|
`PUT <target>/_aliases/<alias>`
|
|
|
|
[[add-alias-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage`
|
|
<<privileges-list-indices,index privilege>> for the alias and its data streams
|
|
or indices.
|
|
|
|
[[add-alias-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<alias>`::
|
|
(Required, string) Alias to update. If the alias doesn't exist, the request
|
|
creates it. Index alias names support <<date-math-index-names,date math>>.
|
|
|
|
`<target>`::
|
|
(Required, string) Comma-separated list of data streams or indices to add.
|
|
Supports wildcards (`*`). Wildcard patterns that match both data streams and
|
|
indices return an error.
|
|
|
|
[[add-alias-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|
|
|
|
[[add-alias-api-request-body]]
|
|
==== {api-request-body-title}
|
|
|
|
include::aliases.asciidoc[tag=alias-options]
|