Get component templates

GET /_component_template/{name}
GET /_component_template

Api key auth Basic auth Bearer auth

Get information about component templates.

Required authorization

Cluster privileges: manage_index_templates

Path Parameters

name string Name optional

Name of component template to retrieve. Wildcard (*) expressions are supported.

Leave it out to use /_component_template.

Query Parameters

Response

application/json

Examples

A successful response for retrieving information about a component template.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_component_template/template_1

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

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

Java Elasticsearch Java Client

client.cluster().getComponentTemplate(g -> g
    .name("template_1")
);

C# Elasticsearch .NET Client

var response = await client.Cluster
    .GetComponentTemplateAsync(d1 => d1
        .Name("template_1")
    );

PHP Elasticsearch PHP Client

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

Ruby Elasticsearch Ruby Client

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

Response

{
  "component_templates" : [
    {
      "name" : "my-component-template",
      "component_template" : {
        "version" : 1,
        "_meta" : {
          "description" : "my custom component template"
        },
        "template" : {
          "settings" : {
            "index" : {
              "number_of_shards" : "1"
            }
          },
          "mappings" : {
            "properties" : {
              "@timestamp" : {
                "type" : "date"
              },
              "message" : {
                "type" : "text"
              }
            }
          }
        },
        "created_date" : "2024-01-01T12:00:00.000Z",
        "created_date_millis" : 1704110400000,
        "modified_date" : "2025-01-01T12:00:00.000Z",
        "modified_date_millis" : 1735732800000
      }
    }
  ]
}

Required authorization

Path Parameters

Query Parameters { flat_settings , settings_filter , include_defaults , local , master_timeout , }

Response

Query Parameters