[[reference-indices-simulate_index_template]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
=== client.indices.simulateIndexTemplate

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

{ref}/indices-simulate-index.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(IndicesSimulateIndexTemplateRequest, options?): Promise<IndicesSimulateIndexTemplateResponse>
----

[discrete]
===== `IndicesSimulateIndexTemplateRequest`

[source,ts]
----
interface IndicesSimulateIndexTemplateRequest extends <<shared-type-request-base, RequestBase>> {
  name: <<shared-type-name, Name>>
  master_timeout?: <<shared-type-duration, Duration>>
  include_defaults?: boolean
}
----

[discrete]
===== `IndicesSimulateIndexTemplateResponse`

[source,ts]
----
interface IndicesSimulateIndexTemplateResponse {
  overlapping?: IndicesSimulateTemplateOverlapping[]
  template: IndicesSimulateTemplateTemplate
}
----

