Delete an alias

DELETE /{index}/_aliases/{name}
DELETE /{index}/_alias/{name}

Auth

Removes a data stream or index from an alias.

Required privileges

Index privileges manage

Path parameters

index union string | string[] required: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*).
name union string | string[] required: Comma-separated list of aliases to remove. Supports wildcards (*). To remove all aliases, use * or _all.

Query parameters

master_timeout union oneOf · default: 30s: 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.; Values: -1 0
timeout union oneOf · default: 30s: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.; Values: -1 0

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.
errors boolean

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

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

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/my-data-stream/_alias/my-alias" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().deleteAlias(d -> d
    .index("my-data-stream")
    .name("my-alias")
);

C# Elasticsearch .NET Client

var response = await client.Indices.DeleteAliasAsync(indices: new[] { "my-data-stream" }, name: new[] { "my-alias" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->deleteAlias([
    "index" => "my-data-stream",
    "name" => "my-alias",
]);

Ruby Elasticsearch Ruby Client

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

Response

{
  "acknowledged": false,
  "errors": false
}

Generated from the API spec