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.

« indices.putMapping indices.putTemplate »
Elastic Docs ›elasticsearch.js ›7.2 API

indices.putSettings

edit

indices.putSettings

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

Change specific index level settings in real time.

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

Params

masterTimeout

DurationString — Specify timeout for connection to master

timeout

DurationString — Explicit operation timeout

preserveExisting

Boolean — Whether to update existing settings. If set to true existing settings on an index remain unchanged, the default is false

ignoreUnavailable

Boolean — Whether specified concrete indices should be ignored when unavailable (missing or closed)

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)

[expandWildcards=open]

String — Whether to expand wildcard expression to concrete indices that are open, closed or both.

Options
  • "open"
  • "closed"
  • "none"
  • "all"

flatSettings

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

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

body

Object, JSON — The 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

« indices.putMapping indices.putTemplate »