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.

« cat.help cat.master »

› ›

cat.indices

edit

cat.indices

edit

client.cat.indices({
  index: string | string[],
  format: string,
  bytes: 'b' | 'k' | 'm' | 'g',
  local: boolean,
  master_timeout: string,
  h: string | string[],
  health: 'green' | 'yellow' | 'red',
  help: boolean,
  pri: boolean,
  s: string | string[],
  v: boolean
})

Reference

`index`	`string \| string[]` - A comma-separated list of index names to limit the returned information
`format`	`string` - a short version of the Accept header, e.g. json, yaml
`bytes`	`'b' \| 'k' \| 'm' \| 'g'` - The unit in which to display byte values
`local`	`boolean` - Return local information, do not retrieve the state from master node (default: false)
`master_timeout` or `masterTimeout`	`string` - Explicit operation timeout for connection to master node
`h`	`string \| string[]` - Comma-separated list of column names to display
`health`	`'green' \| 'yellow' \| 'red'` - A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
`help`	`boolean` - Return help information
`pri`	`boolean` - Set to true to return stats only for primary shards
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`v`	`boolean` - Verbose mode. Display column headers

« cat.help cat.master »