New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Delete index API Delete index template API »
Elastic Docs ›Elasticsearch Guide [7.12] ›REST APIs ›Index APIs

Delete index alias API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete index alias API

edit

Deletes an existing index alias.

An index alias is a secondary name for one or more indices. Most Elasticsearch APIs accept an index alias in place of an index name.

DELETE /my-index-000001/_alias/alias1
Copy as curlTry in Elastic 

Request

edit

DELETE /<index>/_alias/<alias>

DELETE /<index>/_aliases/<alias>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the manage index privilege for both the index and index alias.

Path parameters

edit
<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) Comma-separated list or wildcard expression of index alias names used to limit the request.

To delete all aliases, use a value of _all or *.

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 index API Delete index template API »
Was this helpful?
Feedback