Elasticsearch Template

By Opster Team

Updated: Jan 28, 2024

| 1 min read

If you want to learn more about Elasticsearch templates, check out this guide.


A template in Elasticsearch falls into one of the two following categories and is indexed inside Elasticsearch using its dedicated endpoint: 

  1. Index templates, which are a way to define a set of rules including index settings, mappings and an index pattern. The template is applied automatically whenever a new index is created with the matching pattern. Templates are also used to dynamically apply custom mapping for the fields which are not predefined inside existing mapping.
  2. Search templates, which help in defining templates for search queries using mustache scripting language. These templates act as a placeholder for variables defined inside the search queries.


Create a dynamic index template

PUT /_template/template_1?pretty
  "index_patterns": [
  "settings": {
    "number_of_shards": 2
  "mappings": {
    "dynamic_templates": [
        "strings": {
          "match_mapping_type": "string",
          "mapping": {
            "type": "keyword"
    "properties": {
      "host_name": {
        "type": "keyword"
      "created_at": {
        "type": "date"

Create a search template

POST /_scripts/search_template_1?pretty
    "script": {
        "lang": "mustache",
        "source": {
            "query": {
                "match": {
                    "description": "{{query_string}}"

Executing a search query using search template

GET /_search/template?pretty
    "id": "search_template_1", 
    "params": {
        "query_string": "hello world"

The search request will be executed by default on all the indices available in the cluster and can be limited to particular indices using an index parameter.


  • A dynamic index template is always useful when you do not know the field names in advance and want to control their mapping as per the business use case.

Related log errors to this ES concept

Error deleting template request was not acknowledged
Removing template
Adding template for index patterns
Error loading template as part of metadata upgrading
Starting template upgrade to version templates will be updated and will be removed
Error updating template
Error deleting template
Error adding watcher template request was not acknowledged
Error adding watcher template
Failed to put audit trail template
Error loading the template for the notification message index
Error adding lifecycle policy for

< Page: 1 of 9 >