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.

« cluster.allocationExplain cluster.health »
Elastic Docs ›Elasticsearch Node.js client [5.x] ›API Reference

cluster.getSettings

edit

cluster.getSettings

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

Reference

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.
« cluster.allocationExplain cluster.health »