You are looking at preliminary documentation for a future release.
Not what you want? See the
current release documentation.
Delete alias APIedit
Removes a data stream or index from an alias.
response = client.indices.delete_alias( index: 'my-data-stream', name: 'my-alias' ) puts response
DELETE my-data-stream/_alias/my-alias
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage
index privilege for the alias and it data streams or indices.
Path parametersedit
-
<alias>
-
(Required, string) Comma-separated list of aliases to remove. Supports wildcards
(
*
). To remove all aliases, use*
or_all
. -
<target>
-
(Required, string) Comma-separated list of data streams or indices used to limit
the request. Supports wildcards (
*
).
Query parametersedit
-
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout. -
timeout
-
(Optional, time units)
Period to wait for a response from all relevant nodes in the cluster after
updating the cluster metadata. If no response is received before the timeout
expires, the cluster metadata update still applies but the response will
indicate that it was not completely acknowledged. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout.