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.

« snapshot.restore snapshot.verifyRepository »
Elastic Docs ›elasticsearch.js ›7.6 API

snapshot.status

edit

snapshot.status

edit
client.snapshot.status([params, [callback]])

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

Params

masterTimeout

DurationString — Explicit operation timeout for connection to master node

ignoreUnavailable

Boolean — Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown

repository

String — A repository name

snapshot

String, String[], Boolean — A comma-separated list of snapshot names

back to top

« snapshot.restore snapshot.verifyRepository »