IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cat.fielddata cat.help »
Elastic Docs ›elasticsearch.js ›5.6 API

cat.health

edit

cat.health

edit
client.cat.health([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

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)

masterTimeout

DurationString — Explicit operation timeout for connection to master node

h

String, String[], Boolean — Comma-separated list of column names to display

help

Boolean — Return help information

s

String, String[], Boolean — Comma-separated list of column names or column aliases to sort by

[ts=true]

Boolean — Set to false to disable timestamping

v

Boolean — Verbose mode. Display column headers

back to top

« cat.fielddata cat.help »