Get snapshot information Generally available; Added in 0.0.0

GET /_snapshot/{repository}/{snapshot}
Api key auth Basic auth Bearer auth

NOTE: The after parameter and next field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. Snapshots concurrently created may be seen during an iteration.

highlight#highlightFromAnchor" href="#topic-required-authorization"> Required authorization

  • Cluster privileges: monitor_snapshot

Path parameters

  • repository string Required

    A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

  • snapshot string | array[string] Required

    A comma-separated list of snapshot names to retrieve Wildcards (*) are supported.

    • To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
    • To get information about any snapshots that are currently running, use _current.

Query parameters

  • after string Generally available; Added in 7.14.0

    An offset identifier to start pagination from as returned by the next field in the response body.

  • from_sort_value string Generally available; Added in 7.16.0

    The value of the current sort column at which to start retrieval. It can be a string snapshot- or a repository name when sorting by snapshot or repository name. It can be a millisecond time value or a number when sorting by index- or shard count.

  • ignore_unavailable boolean

    If false, the request returns an error for any snapshots that are unavailable.

  • index_details boolean Generally available; Added in 7.13.0

    If true, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. The default is false, meaning that this information is omitted.

  • index_names boolean Generally available; Added in 8.3.0

    If true, the response includes the name of each index in each snapshot.

  • include_repository boolean

    If true, the response includes the repository name in each snapshot.

  • master_timeout string

    The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

    Values are -1 or 0.

  • order string Generally available; Added in 7.14.0

    The sort order. Valid values are asc for ascending and desc for descending order. The default behavior is ascending order.

    Supported values include:

    • asc: Ascending (smallest to largest)
    • desc: Descending (largest to smallest)

    Values are asc or desc.

  • offset number Generally available; Added in 7.15.0

    Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.

  • size number Generally available; Added in 7.14.0

    The maximum number of snapshots to return. The default is 0, which means to return all that match the request without limit.

  • slm_policy_filter string Generally available; Added in 7.16.0

    Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.

    You can use wildcards (*) and combinations of wildcards followed by exclude patterns starting with -. For example, the pattern *,-policy-a-\* will return all snapshots except for those that were created by an SLM policy with a name starting with policy-a-. Note that the wildcard pattern * matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were not created by an SLM policy, you can use the special pattern _none that will match all snapshots without an SLM policy.

  • sort string Generally available; Added in 7.14.0

    The sort order for the result. The default behavior is sorting by snapshot start time stamp.

    Values are start_time, duration, name, index_count, repository, shard_count, or failed_shard_count.

  • state string | array[string] Generally available; Added in 9.1.0

    Only return snapshots with a state found in the given comma-separated list of snapshot states. The default is all snapshot states.

    Supported values include:

    • IN_PROGRESS: The snapshot process has started.
    • SUCCESS: The snapshot process completed successfully.
    • FAILED: The snapshot failed.
    • PARTIAL: The snapshot was partially successful.
    • INCOMPATIBLE: The snapshot is incompatible with the current version of the cluster.

    Values are IN_PROGRESS, SUCCESS, FAILED, PARTIAL, or INCOMPATIBLE.

  • verbose boolean

    If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

    NOTE: The parameters size, order, after, from_sort_value, offset, slm_policy_filter, and sort are not supported when you set verbose=false and the sort order for requests with verbose=false is undefined.

Responses

GET /_snapshot/{repository}/{snapshot}
dropdown#toggle click@window->dropdown#hide touchend@window->dropdown#hide" data-dropdown-target="button" data-scrollable="false" data-headings="false" aria-expanded="false" aria-haspopup="true" role="menu" tabindex="0">
Console 
GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000

resp = client.snapshot.get(
    repository="my_repository",
    snapshot="snapshot_*",
    sort="start_time",
    from_sort_value="1577833200000",
)
const response = await client.snapshot.get({
  repository: "my_repository",
  snapshot: "snapshot_*",
  sort: "start_time",
  from_sort_value: 1577833200000,
});
response = client.snapshot.get(
  repository: "my_repository",
  snapshot: "snapshot_*",
  sort: "start_time",
  from_sort_value: "1577833200000"
)
$resp = $client->snapshot()->get([
    "repository" => "my_repository",
    "snapshot" => "snapshot_*",
    "sort" => "start_time",
    "from_sort_value" => "1577833200000",
]);
curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000"
client.snapshot().get(g -> g
    .fromSortValue("1577833200000")
    .repository("my_repository")
    .snapshot("snapshot_*")
    .sort(SnapshotSort.StartTime)
);
Response examples (200)
A successful response from `GET /_snapshot/my_repository/snapshot_*?sort=start_time&from_sort_value=1577833200000`. The response contains information for all snapshots with names starting with `snapshot_` and that started on or after timestamp `1577833200000` (Jan 1st 2020) when sorted by snapshot start time in the default ascending order. 
{
  "snapshots": [
    {
      "snapshot": "snapshot_1",
      "uuid": "dKb54xw67gvdRctLCxSket",
      "repository": "my_repository",
      "version_id": <version_id>,
      "version": <version>,
      "indices": [],
      "data_streams": [],
      "feature_states": [],
      "include_global_state": true,
      "state": "SUCCESS",
      "start_time": "2020-07-06T21:55:18.128Z",
      "start_time_in_millis": 1593093628849,
      "end_time": "2020-07-06T21:55:18.129Z",
      "end_time_in_millis": 1593093628850,
      "duration_in_millis": 1,
      "failures": [],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      }
    },
    {
      "snapshot": "snapshot_2",
      "uuid": "vdRctLCxSketdKb54xw67g",
      "repository": "my_repository",
      "version_id": <version_id>,
      "version": <version>,
      "indices": [],
      "data_streams": [],
      "feature_states": [],
      "include_global_state": true,
      "state": "SUCCESS",
      "start_time": "2020-07-06T21:55:18.130Z",
      "start_time_in_millis": 1593093628851,
      "end_time": "2020-07-06T21:55:18.130Z",
      "end_time_in_millis": 1593093628851,
      "duration_in_millis": 0,
      "failures": [],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      }
    },
    {
      "snapshot": "snapshot_3",
      "uuid": "dRctdKb54xw67gvLCxSket",
      "repository": "my_repository",
      "version_id": <version_id>,
      "version": <version>,
      "indices": [],
      "data_streams": [],
      "feature_states": [],
      "include_global_state": true,
      "state": "SUCCESS",
      "start_time": "2020-07-06T21:55:18.131Z",
      "start_time_in_millis": 1593093628852,
      "end_time": "2020-07-06T21:55:18.135Z",
      "end_time_in_millis": 1593093628856,
      "duration_in_millis": 4,
      "failures": [],
      "shards": {
        "total": 0,
        "failed": 0,
        "successful": 0
      }
    }
  ],
  "total": 3,
  "remaining": 0
}