Simulate an index

POST /_index_template/_simulate_index/{name}

Api key auth

Get the index configuration that would be applied to the specified index from an existing index template.

Required authorization

Cluster privileges: manage_index_templates

Path Parameters

name string Name required: Name of the index to simulate

Query Parameters

Request

Response

application/json

Examples

A successful response from POST /_index_template/_simulate_index/my-index-000001.

Request Console 1 / 7 languages

Console Kibana Dev Tools

POST /_index_template/_simulate_index/my-index-000001

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.simulateIndexTemplate({
  name: "my-index-000001",
  index_template: null,
});

Python Elasticsearch Python Client

resp = client.indices.simulate_index_template(
    name="my-index-000001",
    index_template=None,
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/_index_template/_simulate_index/my-index-000001" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().simulateIndexTemplate(s -> s
    .name("my-index-000001")
);

PHP Elasticsearch PHP Client

$resp = $client->indices()->simulateIndexTemplate([
    "name" => "my-index-000001",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.simulate_index_template(
  name: "my-index-000001"
)

Response

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

Required authorization

Path Parameters

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

Request { index_patterns , composed_of , template , version , priority , _meta , allow_auto_create , data_stream , deprecated , ignore_missing_component_templates , created_date , created_date_millis , modified_date , modified_date_millis , }

Response

Query Parameters

Request