indices.get | Elasticsearch Node.js client [5.x]

WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

› ›

« indices.forcemerge indices.getAlias »

indices.getedit

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

Reference

`index`	`string \| string[]` - A comma-separated list of index names
`feature`	`string \| string[]` - A comma-separated list of features
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`ignore_unavailable` or `ignoreUnavailable`	`boolean` - Ignore unavailable indexes (default: false)
`allow_no_indices` or `allowNoIndices`	`boolean` - Ignore if a wildcard expression resolves to no concrete indices (default: false)
`expand_wildcards` or `expandWildcards`	`'open' \| 'closed' \| 'none' \| 'all'` - Whether wildcard expressions should get expanded to open or closed indices (default: open) Default: `open`
`flat_settings` or `flatSettings`	`boolean` - Return settings in flat format (default: false)
`include_defaults` or `includeDefaults`	`boolean` - Whether to return all default setting for each of the indices.

« indices.forcemerge indices.getAlias »