This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Get snapshot.

Retrieves information about a snapshot.

Path parameters

ParameterData typeDescription
repositoryStringThe repository that contains the snapshot to retrieve.
snapshotStringSnapshot to retrieve.

Query parameters

ParameterData typeDescription
verboseBooleanWhether to show all, or just basic snapshot information. If true, returns all information. If false, omits information like start/end times, failures, and shards. Optional, defaults to true.
ignore_unavailableBooleanHow to handle snapshots that are unavailable (corrupted or otherwise temporarily can’t be returned). If true and the snapshot is unavailable, the request does not return the snapshot. If false and the snapshot is unavailable, the request returns an error. Optional, defaults to false.

Example request

The following request retrieves information for the my-first-snapshot located in the my-opensearch-repo repository:

  1. GET _snapshot/my-opensearch-repo/my-first-snapshot

copy

Example response

Upon success, the response returns snapshot information:

  1. {
  2.   "snapshots" : [
  3.     {
  4.       "snapshot" : "my-first-snapshot",
  5.       "uuid" : "3P7Qa-M8RU6l16Od5n7Lxg",
  6.       "version_id" : 136217927,
  7.       "version" : "2.0.1",
  8.       "indices" : [
  9.         ".opensearch-observability",
  10.         ".opendistro-reports-instances",
  11.         ".opensearch-notifications-config",
  12.         "shakespeare",
  13.         ".opendistro-reports-definitions",
  14.         "opensearch_dashboards_sample_data_flights",
  15.         ".kibana_1"
  16.       ],
  17.       "data_streams" : [ ],
  18.       "include_global_state" : true,
  19.       "state" : "SUCCESS",
  20.       "start_time" : "2022-08-11T20:30:00.399Z",
  21.       "start_time_in_millis" : 1660249800399,
  22.       "end_time" : "2022-08-11T20:30:14.851Z",
  23.       "end_time_in_millis" : 1660249814851,
  24.       "duration_in_millis" : 14452,
  25.       "failures" : [ ],
  26.       "shards" : {
  27.         "total" : 7,
  28.         "failed" : 0,
  29.         "successful" : 7
  30.       }
  31.     }
  32.   ]
  33. }

Response fields

FieldData typeDescription
snapshotstringSnapshot name.
uuidstringSnapshot’s universally unique identifier (UUID).
version_idintBuild ID of the Open Search version that created the snapshot.
versionfloatOpen Search version that created the snapshot.
indicesarrayIndices in the snapshot.
data_streamsarrayData streams in the snapshot.
include_global_statebooleanWhether the current cluster state is included in the snapshot.
start_timestringDate/time when the snapshot creation process began.
start_time_in_millislongTime (in milliseconds) when the snapshot creation process began.
end_timestringDate/time when the snapshot creation process ended.
end_time_in_millislongTime (in milliseconds) when the snapshot creation process ended.
duration_in_millislongTotal time (in milliseconds) that the snapshot creation process lasted.
failuresarrayFailures, if any, that occured during snapshot creation.
shardsobjectTotal number of shards created along with number of successful and failed shards.
statestringSnapshot status. Possible values: IN_PROGRESS, SUCCESS, FAILED, PARTIAL.