indices.getSettings

edit
client.indices.getSettings({
  index: string | string[],
  name: string | string[],
  ignore_unavailable: boolean,
  allow_no_indices: boolean,
  expand_wildcards: 'open' | 'closed' | 'none' | 'all',
  flat_settings: boolean,
  local: boolean,
  include_defaults: boolean
})

Reference

index

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

name

string | string[] - The name of the settings that should be included

ignore_unavailable or ignoreUnavailable

boolean - Whether specified concrete indices should be ignored when unavailable (missing or closed)

allow_no_indices or 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)

expand_wildcards or expandWildcards

'open' | 'closed' | 'none' | 'all' - Whether to expand wildcard expression to concrete indices that are open, closed or both.
Default: open,closed

flat_settings or flatSettings

boolean - Return settings in flat format (default: false)

local

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

include_defaults or includeDefaults

boolean - Whether to return all default setting for each of the indices.