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

50 lines
989 B
Plaintext

[[indices-delete-alias]]
=== Delete index alias API
++++
<titleabbrev>Delete index alias</titleabbrev>
++++
Deletes an existing index alias.
include::alias-exists.asciidoc[tag=index-alias-def]
[source,js]
----
DELETE /twitter/_alias/alias1
----
// CONSOLE
// TEST[setup:twitter]
// TEST[s/^/PUT twitter\/_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::{docdir}/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::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]