NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

indices.get

edit

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

indices.get

edit

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

Reference

`index`	`string \| string[]` - A comma-separated list of index names
`include_type_name` or `includeTypeName`	`boolean` - Whether to add the type name to the response (default: true)
`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.
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master

« indices.forcemerge indices.getAlias »