Get snapshot information Added in 2.1.0
Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
Query parameters
-
master_timeout string
Period to wait for a connection to the master node.
-
time string
Unit used to display time values.
Values are
nanos
,micros
,ms
,s
,m
,h
, ord
.
GET
/_cat/snapshots
curl \
-X GET http://api.example.com/_cat/snapshots
Response examples (200)
[
{
"id": "string",
"repository": "string",
"status": "string",
"": 42.0,
"end_time": "string",
"duration": "string",
"indices": "string",
"successful_shards": "string",
"failed_shards": "string",
"total_shards": "string",
"reason": "string"
}
]
Response examples (200)
A successful response from `GET /_cat/snapshots/repo1?v=true&s=id`.
id repository status start_epoch start_time end_epoch end_time duration indices successful_shards failed_shards total_shards
snap1 repo1 FAILED 1445616705 18:11:45 1445616978 18:16:18 4.6m 1 4 1 5
snap2 repo1 SUCCESS 1445634298 23:04:58 1445634672 23:11:12 6.2m 2 10 0 10