Simulate an index

POST /_index_template/_simulate_index/{name}

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

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

Query parameters

Request body

index_patterns string required: Array of wildcard (*) expressions used to match the names of data streams and indices during creation.
composed_of string[] required: An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.
template object: Template to be applied. It may optionally include an aliases, mappings, or settings configuration.
version number: Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.
priority number: Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.
_meta object: Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.
allow_auto_create boolean
data_stream object: If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.
deprecated boolean: Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.
ignore_missing_component_templates string: A list of component template names that are allowed to be absent.

Response

application/json

Examples

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

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

{
  "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

Authentication

Path parameters

Query parameters

Request body { }

Response

Request body