IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cluster.allocationExplain cluster.health »
Elastic Docs ›elasticsearch.js ›7.3 API

cluster.getSettings

edit

cluster.getSettings

edit
client.cluster.getSettings([params, [callback]])

Get cluster settings (previously set with putSettings())

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

flatSettings

Boolean — Return settings in flat format (default: false)

masterTimeout

DurationString — Explicit operation timeout for connection to master node

timeout

DurationString — Explicit operation timeout

includeDefaults

Boolean — Whether to return all default clusters setting.

back to top

« cluster.allocationExplain cluster.health »