WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

Elastic Docs ›Elasticsearch Node.js client [5.x] ›API Reference
« indices.putSettings indices.recovery »

indices.putTemplateedit

client.indices.putTemplate({
  name: string,
  order: number,
  create: boolean,
  timeout: string,
  master_timeout: string,
  flat_settings: boolean,
  body: object
})

Reference

name

string - The name of the template

order

number - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)

create

boolean - Whether the index template should only be added if new or can also replace an existing one

timeout

string - Explicit operation timeout

master_timeout or masterTimeout

string - Specify timeout for connection to master

flat_settings or flatSettings

boolean - Return settings in flat format (default: false)

body

object - The template definition
« indices.putSettings indices.recovery »