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

« cat.fielddata cat.help »

› ›

cat.health

edit

cat.health

edit

client.cat.health({
  format: string,
  local: boolean,
  master_timeout: string,
  h: string | string[],
  help: boolean,
  s: string | string[],
  ts: boolean,
  v: boolean
})

Reference

`format`	`string` - a short version of the Accept header, e.g. json, yaml
`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
`help`	`boolean` - Return help information
`s`	`string \| string[]` - Comma-separated list of column names or column aliases to sort by
`ts`	`boolean` - Set to false to disable timestamping Default: `true`
`v`	`boolean` - Verbose mode. Display column headers

« cat.fielddata cat.help »