Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 3.3 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Delete Index Alias API

Introduced 1.0

Deletes an existing alias.

Endpoints

DELETE /<index>/_alias/<alias>
DELETE /<index>/_aliases/<alias>

Path parameters

The following table lists the available path parameters. All path parameters are required.

Parameter Data type Description
<index> String Comma-separated list or wildcard expression of index names used to limit the request. To include all indexes in the cluster, use _all or *.
<alias> String Comma-separated list or wildcard expression of alias names to delete. To delete all aliases, use _all or *.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Parameter Data type Description
cluster_manager_timeout Time The amount of time to wait for a response from the cluster manager node. Default is 30s.
timeout Time The amount of time to wait for a response from the cluster. Default is 30s.

Example request

The following request deletes the alias1 alias from the logs_20302801 index:

DELETE /logs_20302801/_alias/alias1
response = client.indices.delete_alias(
  index = "logs_20302801",
  name = "alias1"
)

Example response

{
    "acknowledged": true
}

Response body fields

The following table lists all response body fields.

Field Data type Description
acknowledged Boolean Whether the request was received.

For more information about index aliases, see Index aliases.

350 characters left

Have a question? .

Want to contribute? or .