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.pendingTasks cluster.remoteInfo »
Elastic Docs ›elasticsearch.js ›5.6 API

cluster.putSettings

edit

cluster.putSettings

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

Update cluster wide specific settings.

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

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

« cluster.pendingTasks cluster.remoteInfo »