Delete a legacy index template

DELETE /_template/{name}

Auth Deprecated

Important

This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Required authorization

Cluster privileges manage_index_templates

Path parameters

name string required: The name of the legacy index template to delete. Wildcard (*) expressions are supported.

Query parameters

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

Response

application/json

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

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _template/.cloud-hot-warm-allocation-0

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.deleteTemplate({
  name: ".cloud-hot-warm-allocation-0",
});

Python Elasticsearch Python Client

resp = client.indices.delete_template(
    name=".cloud-hot-warm-allocation-0",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_template/.cloud-hot-warm-allocation-0" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().deleteTemplate(d -> d
    .name(".cloud-hot-warm-allocation-0")
);

C# Elasticsearch .NET Client

var response = await client.Indices.DeleteTemplateAsync(name: ".cloud-hot-warm-allocation-0");

PHP Elasticsearch PHP Client

$resp = $client->indices()->deleteTemplate([
    "name" => ".cloud-hot-warm-allocation-0",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.delete_template(
  name: ".cloud-hot-warm-allocation-0"
)

Response

{
  "acknowledged": false
}

Generated from the API spec