IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« Create or update index template API Delete dangling index API »

› › ›

Delete component template API

edit

Delete component template API

edit

Deletes an existing component template.

response = client.cluster.delete_component_template(
  name: 'template_1'
)
puts response

DELETE _component_template/template_1

The provided <component-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 component templates.

Request

edit

DELETE /_component_template/<component-template>

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 component template API to delete one or more component templates Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

Path parameters

edit

<component-template>: (Required, string) Comma-separated list or wildcard expression of component template names used to limit the request.

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.
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.

« Create or update index template API Delete dangling index API »