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

› ›

cluster.getSettings

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

client.cluster.getSettings({
  flat_settings: boolean,
  master_timeout: string,
  timeout: string,
  include_defaults: boolean
})

`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
`timeout`	`string` - Explicit operation timeout
`include_defaults` or `includeDefaults`	`boolean` - Whether to return all default clusters setting.