Delete component templates

DELETE /_component_template/{name}

Auth

Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

Required privileges

Cluster privileges manage_index_templates

Path parameters

name union string | string[] required: Comma-separated list or wildcard expression of component template names used to limit the request.

Query parameters

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

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

View as Markdown

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE _component_template/template_1

JavaScript Elasticsearch JavaScript Client

const response = await client.cluster.deleteComponentTemplate({
  name: "template_1",
});

Python Elasticsearch Python Client

resp = client.cluster.delete_component_template(
    name="template_1",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_component_template/template_1" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cluster().deleteComponentTemplate(d -> d
    .name("template_1")
);

C# Elasticsearch .NET Client

var response = await client.Cluster.DeleteComponentTemplateAsync(name: new[] { "template_1" });

PHP Elasticsearch PHP Client

$resp = $client->cluster()->deleteComponentTemplate([
    "name" => "template_1",
]);

Ruby Elasticsearch Ruby Client

response = client.cluster.delete_component_template(
  name: "template_1"
)

Response

{
  "acknowledged": false
}

Generated from the API spec