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.

Elastic Docs ›Elasticsearch Node.js client [5.x] ›API Reference
« cat.shards cat.tasks »

cat.snapshotsedit

client.cat.snapshots({
  repository: string | string[],
  format: string,
  ignore_unavailable: boolean,
  master_timeout: string,
  h: string | string[],
  help: boolean,
  s: string | string[],
  v: boolean
})

Reference

repository

string | string[] - Name of repository from which to fetch the snapshot information

format

string - a short version of the Accept header, e.g. json, yaml

ignore_unavailable or ignoreUnavailable

boolean - Set to true to ignore unavailable snapshots

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

v

boolean - Verbose mode. Display column headers
« cat.shards cat.tasks »