IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Delete dangling index API Delete index API »

› › ›

Delete alias API

edit

Delete alias API

edit

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

Request

edit

DELETE <target>/_alias/<alias>

DELETE <target>/_aliases/<alias>

Prerequisites

edit

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

Path parameters

edit

<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 parameters

edit

master_timeout: (Optional, time units) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
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.

« Delete dangling index API Delete index API »