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

« indices.getFieldMapping indices.getSettings »

› ›

indices.getMapping

edit

indices.getMapping

edit

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

Reference

`index`	`string \| string[]` - A comma-separated list of index names
`type`	`string \| string[]` - A comma-separated list of document types
`include_type_name` or `includeTypeName`	`boolean` - Whether to add the type name to the response.
`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`
`master_timeout` or `masterTimeout`	`string` - Specify timeout for connection to master
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)

« indices.getFieldMapping indices.getSettings »