This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.

« Delete index API Delete index template API »

› › ›

Delete index template API

edit

Delete index template API

edit

Deletes an index template.

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

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

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

DELETE /_index_template/my-index-template

Request

edit

DELETE /_index_template/<index-template>

The provided <index-template> may contain multiple template names separated by a comma. If multiple template names are specified then there is no wildcard support and the provided names should match completely with existing templates.

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_index_templates or manage cluster privilege to use this API.

Description

edit

Use the delete index template API to delete one or more index templates. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Path parameters

edit

<index-template>: (Required, string) Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

Query parameters

edit

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

« Delete index API Delete index template API »