Delete an index template

Auth

The provided

Required privileges

name union string | string[] required: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

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

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 /_index_template/my-index-template

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.deleteIndexTemplate({
  name: "my-index-template",
});

Python Elasticsearch Python Client

resp = client.indices.delete_index_template(
    name="my-index-template",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_index_template/my-index-template" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().deleteIndexTemplate(d -> d
    .name("my-index-template")
);

C# Elasticsearch .NET Client

var response = await client.Indices.DeleteIndexTemplateAsync(name: new[] { "my-index-template" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->deleteIndexTemplate([
    "name" => "my-index-template",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.delete_index_template(
  name: "my-index-template"
)

Response

{
  "acknowledged": false
}

Generated from the API spec