OpenSearch/docs/reference/indices/delete-alias.asciidoc

49 lines
1021 B
Plaintext

[[indices-delete-alias]]
=== Delete index alias API
++++
<titleabbrev>Delete index alias</titleabbrev>
++++
Deletes an existing index alias.
include::{es-repo-dir}/glossary.asciidoc[tag=index-alias-desc]
[source,console]
----
DELETE /my-index-000001/_alias/alias1
----
// TEST[setup:my_index]
// TEST[s/^/PUT my-index-000001\/_alias\/alias1\n/]
[[delete-alias-api-request]]
==== {api-request-title}
`DELETE /<index>/_alias/<alias>`
`DELETE /<index>/_aliases/<alias>`
[[delete-alias-api-path-params]]
==== {api-path-parms-title}
`<index>`::
(Required, string)
Comma-separated list or wildcard expression of index names
used to limit the request.
+
To include all indices in the cluster,
use a value of `_all` or `*`.
`<alias>`::
(Required, string)
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias]
+
To delete all aliases,
use a value of `_all` or `*`.
[[delete-alias-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]