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.getMapping indices.getTemplate »
Elastic Docs ›elasticsearch.js ›7.0 API

indices.getSettings

edit

indices.getSettings

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

Retrieve settings for one or more (or all) indices.

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

Params

masterTimeout

DurationString — Specify timeout for connection to master

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,closed]

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)

local

Boolean — Return local information, do not retrieve the state from master node (default: false)

includeDefaults

Boolean — Whether to return all default setting for each of the indices.

index

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

name

String, String[], Boolean — The name of the settings that should be included

back to top

« indices.getMapping indices.getTemplate »