Simulate an index template

POST /_index_template/_simulate/{name}
POST /_index_template/_simulate

Get the index configuration that would be applied by a particular index template.

Required authorization

Cluster privileges: manage_index_templates

Path Parameters

name string Name optional

Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.

Leave it out to use /_index_template/_simulate.

To see what settings will be applied by a template before you add it to the cluster, you can pass a template configuration in the request body. The specified template is used for the simulation if it has a higher priority than existing templates.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST /_index_template/_simulate
{
  "index_patterns": ["my-index-*"],
  "composed_of": ["ct2"],
  "priority": 10,
  "template": {
    "settings": {
      "index.number_of_replicas": 1
    }
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.simulateTemplate({
  index_patterns: ["my-index-*"],
  composed_of: ["ct2"],
  priority: 10,
  template: {
    settings: {
      "index.number_of_replicas": 1,
    },
  },
});

Python Elasticsearch Python Client

resp = client.indices.simulate_template(
    index_patterns=[
        "my-index-*"
    ],
    composed_of=[
        "ct2"
    ],
    priority=10,
    template={
        "settings": {
            "index.number_of_replicas": 1
        }
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_index_template/_simulate" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "index_patterns": [
      "my-index-*"
    ],
    "composed_of": [
      "ct2"
    ],
    "priority": 10,
    "template": {
      "settings": {
        "index.number_of_replicas": 1
      }
    }
  }'

Java Elasticsearch Java Client

client.indices().simulateTemplate(s -> s
    .composedOf("ct2")
    .indexPatterns("my-index-*")
    .priority(10L)
    .template(t -> t
        .settings(se -> se
            .otherSettings("index.number_of_replicas", JsonData.fromJson("1"))
        )
    )
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .SimulateTemplateAsync(d1 => d1
        .ComposedOf(["ct2"])
        .IndexPatterns(new[] { "my-index-*" })
        .Priority(10L)
        .Template(d2 => d2
            .Settings(d3 => d3
                .OtherSettings(new Dictionary<string, object>()
                {
                    { "index.number_of_replicas", 1 }
                })
            )
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->simulateTemplate([
    "body" => [
        "index_patterns" => array(
            "my-index-*",
        ),
        "composed_of" => array(
            "ct2",
        ),
        "priority" => 10,
        "template" => [
            "settings" => [
                "index.number_of_replicas" => 1,
            ],
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.indices.simulate_template(
  body: {
    "index_patterns": [
      "my-index-*"
    ],
    "composed_of": [
      "ct2"
    ],
    "priority": 10,
    "template": {
      "settings": {
        "index.number_of_replicas": 1
      }
    }
  }
)

Response

{
  "template" : {
    "settings" : {
      "index" : {
        "number_of_replicas" : "1",
        "routing" : {
          "allocation" : {
            "include" : {
              "_tier_preference" : "data_content"
            }
          }
        }
      }
    },
    "mappings" : {
      "properties" : {
        "@timestamp" : {
          "type" : "date"
        }
      }
    },
    "aliases" : { }
  },
  "overlapping" : [
    {
      "name" : "final-template",
      "index_patterns" : [
        "my-index-*"
      ]
    }
  ]
}

Required authorization

Path Parameters

Query Parameters { create , cause , master_timeout , include_defaults , }

Request { allow_auto_create , index_patterns , composed_of , template , data_stream , priority , version , _meta , ignore_missing_component_templates , deprecated , }

Response

Query Parameters

Request