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.health cat.indices »
Elastic Docs ›Elasticsearch Node.js client [5.x] ›API Reference

cat.help

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

cat.help

edit
client.cat.help({
  help: boolean,
  s: string | string[]
})

Reference

help

boolean - Return help information

s

string | string[] - Comma-separated list of column names or column aliases to sort by
« cat.health cat.indices »