› › ›

Delete alias API

Removes a data stream or index from an alias.

resp = client.indices.delete_alias(
    index="my-data-stream",
    name="my-alias",
)
print(resp)

response = client.indices.delete_alias(
  index: 'my-data-stream',
  name: 'my-alias'
)
puts response

const response = await client.indices.deleteAlias({
  index: "my-data-stream",
  name: "my-alias",
});
console.log(response);

DELETE my-data-stream/_alias/my-alias

Request

DELETE <target>/_alias/<alias>

DELETE <target>/_aliases/<alias>

Prerequisites

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

<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

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.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-alias.html