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.

« indices.putMapping indices.putTemplate »

› ›

indices.putSettings

edit

indices.putSettings

edit

client.indices.putSettings({
  index: string | string[],
  master_timeout: string,
  preserve_existing: boolean,
  ignore_unavailable: boolean,
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all',
  flat_settings: boolean,
  body: object
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`preserve_existing` or `preserveExisting`	`boolean` - Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false`
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allow_no_indices` or `allowNoIndices`	`boolean` - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'none' \| 'all'` - Whether to expand wildcard expression to concrete indices that are open, closed or both. Default: `open`
`flat_settings` or `flatSettings`	`boolean` - Return settings in flat format (default: false)
`body`	`object` - The index settings to be updated

« indices.putMapping indices.putTemplate »