NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

« indices.getSettings indices.getUpgrade »

› ›

indices.getTemplate

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

indices.getTemplate

edit

client.indices.getTemplate({
  name: string | string[],
  include_type_name: boolean,
  flat_settings: boolean,
  master_timeout: string,
  local: boolean
})

Reference

`name`	`string \| string[]` - The comma separated names of the index templates
`include_type_name` or `includeTypeName`	`boolean` - Whether a type should be returned in the body of the mappings.
`flat_settings` or `flatSettings`	`boolean` - Return settings in flat format (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)

« indices.getSettings indices.getUpgrade »