Spec-Zone.ru › Elasticsearch 8
›Elasticsearch Guide [8.17] ›REST APIs ›Index APIs

Delete index template API

New API reference

For the most up-to-date API details, refer to Index APIs.

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

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

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

Description

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

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

Query parameters

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.

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/indices-delete-template.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API