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.shards cat.tasks »
Elastic Docs ›elasticsearch.js ›7.3 API

cat.snapshots

edit

cat.snapshots

edit
client.cat.snapshots([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

ignoreUnavailable

Boolean — Set to true to ignore unavailable snapshots

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

time

String — The unit in which to display time values

Options
  • "d (Days)"
  • "h (Hours)"
  • "m (Minutes)"
  • "s (Seconds)"
  • "ms (Milliseconds)"
  • "micros (Microseconds)"
  • "nanos (Nanoseconds)"

v

Boolean — Verbose mode. Display column headers

repository

String, String[], Boolean — Name of repository from which to fetch the snapshot information

back to top

« cat.shards cat.tasks »