Get snapshot information

GET /_cat/snapshots/{repository}
GET /_cat/snapshots

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.

Required authorization

Cluster privileges: monitor_snapshot

Path Parameters

repository union Name | [] Name optional

A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. _all returns all repositories. If any repository fails during the request, Elasticsearch returns an error.

Leave it out to use /_cat/snapshots.

Query Parameters

ignore_unavailable boolean · default: false

If true, the response does not include information from unavailable snapshots.

h CatSnapshotsColumns · default: ip,hp,rp,r,m,n,cpu,l

A comma-separated list of columns names to display. It supports simple wildcards.

Supported values include:

id (or snapshot): The ID of the snapshot, such as 'snap1'.
repository (or re, repo): The name of the repository, such as 'repo1'.
status (or s): State of the snapshot process. Returned values are: 'FAILED': The snapshot process failed. 'INCOMPATIBLE': The snapshot process is incompatible with the current cluster version. 'IN_PROGRESS': The snapshot process started but has not completed. 'PARTIAL': The snapshot process completed with a partial success. 'SUCCESS': The snapshot process completed with a full success.
start_epoch (or ste, startEpoch): The unix epoch time at which the snapshot process started.
start_time (or sti, startTime): 'HH:MM:SS' time at which the snapshot process started.
end_epoch (or ete, endEpoch): The unix epoch time at which the snapshot process ended.
end_time (or eti, endTime): 'HH:MM:SS' time at which the snapshot process ended.
duration (or dur): The time it took the snapshot process to complete in time units.
indices (or i): The number of indices in the snapshot.
successful_shards (or ss): The number of successful shards in the snapshot.
failed_shards (or fs): The number of failed shards in the snapshot.
total_shards (or ts): The total number of shards in the snapshot.
reason (or r): The reason for any snapshot failures.

Values: id snapshot repository re repo status s start_epoch ste startEpoch start_time sti startTime end_epoch ete endEpoch end_time eti endTime duration dur indices i successful_shards ss failed_shards fs total_shards ts reason r

s union Names

List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting :asc or :desc as a suffix to the column name.

One of: Name or Name[]

master_timeout string Duration · default: 30s

Period to wait for a connection to the master node.

Response

application/json

Examples

A successful response from GET /_cat/snapshots/repo1?v=true&s=id&format=json.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET /_cat/snapshots/repo1?v=true&s=id&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.snapshots({
  repository: "repo1",
  v: "true",
  s: "id",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.snapshots(
    repository="repo1",
    v=True,
    s="id",
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/snapshots/repo1?v=true&s=id&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().snapshots();

PHP Elasticsearch PHP Client

$resp = $client->cat()->snapshots([
    "repository" => "repo1",
    "v" => "true",
    "s" => "id",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.snapshots(
  repository: "repo1",
  v: "true",
  s: "id",
  format: "json"
)

Response

[
  {
    "id": "snap1",
    "repository": "repo1",
    "status": "FAILED",
    "start_epoch": "1445616705",
    "start_time": "18:11:45",
    "end_epoch": "1445616978",
    "end_time": "18:16:18",
    "duration": "4.6m",
    "indices": "1",
    "successful_shards": "4",
    "failed_shards": "1",
    "total_shards": "5"
  },
  {
    "id": "snap2",
    "repository": "repo1",
    "status": "SUCCESS",
    "start_epoch": "1445634298",
    "start_time": "23:04:58",
    "end_epoch": "1445634672",
    "end_time": "23:11:12",
    "duration": "6.2m",
    "indices": "2",
    "successful_shards": "10",
    "failed_shards": "0",
    "total_shards": "10"
  }
]

Required authorization

Path Parameters

Query Parameters { ignore_unavailable , h , s , master_timeout , }

Response

Query Parameters