Delete index template API | Elasticsearch Guide [master]

You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.

› › ›

« Delete index template API Exists API »

Delete index template APIedit

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

Deletes a legacy index template.

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

DELETE /_template/my-legacy-index-template

Requestedit

DELETE /_template/<legacy-index-template>

Prerequisitesedit

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

Path parametersedit

<legacy-index-template>: (Required, string) The name of the legacy index template to delete. Wildcard (*) expressions are supported.

Query parametersedit

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.
timeout: (Optional, time units) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

« Delete index template API Exists API »