Delete alias API | Elasticsearch Guide [master]

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

DELETE <target>/_alias/<alias>

DELETE <target>/_aliases/<alias>

If the Elasticsearch security features are enabled, you must have the manage index privilege for the alias and it data streams or indices.

<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 (*).

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. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.