IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« indices.getSettings indices.getUpgrade »

› ›

indices.getTemplate

edit

`indices.getTemplate`

edit

client.indices.getTemplate([params, [callback]])

Retrieve an index template by its name.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

`includeTypeName`	`Boolean` — Whether a type should be returned in the body of the mappings.
`flatSettings`	`Boolean` — Return settings in flat format (default: false)
`masterTimeout`	`DurationString` — Explicit operation timeout for connection to master node
`local`	`Boolean` — Return local information, do not retrieve the state from master node (default: false)
`name`	`String`, `String[]`, `Boolean` — The comma separated names of the index templates

« indices.getSettings indices.getUpgrade »