Query parameters

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

  • Explicit operation timeout for connection to master node

    Values are -1 or 0.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • snapshotsarray[object] Required
      Hide snapshots attributes Show snapshots attributes object
      • include_global_stateboolean Required
      • indicesobject Required
        Hide indices attribute Show indices attribute object
        • *object Additional properties
          Hide * attributes Show * attributes object
          • shardsobject Required
            Hide shards attribute Show shards attribute object
            • *object Additional properties
          • shards_statsobject Required
            Hide shards_stats attributes Show shards_stats attributes object
          • statsobject Required
            Hide stats attributes Show stats attributes object
            • incrementalobject Required
            • timestring

              A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

            • totalobject Required
      • repositorystring Required
      • shards_statsobject Required
        Hide shards_stats attributes Show shards_stats attributes object
      • snapshotstring Required
      • statestring Required
      • statsobject Required
        Hide stats attributes Show stats attributes object
        • incrementalobject Required
          Hide incremental attributes Show incremental attributes object
        • Time unit for milliseconds

        • timestring

          A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.

        • Time unit for milliseconds

        • totalobject Required
          Hide total attributes Show total attributes object
      • uuidstring Required
GET /_snapshot/_status
curl \
 --request GET 'http://api.example.com/_snapshot/_status' \
 --header "Authorization: $API_KEY"
Response examples (200)
A successful response from `GET _snapshot/my_repository/snapshot_2/_status`. The response contains detailed status information for `snapshot_2` in the `my_repository` repository.
{
  "snapshots" : [
    {
      "snapshot" : "snapshot_2",
      "repository" : "my_repository",
      "uuid" : "lNeQD1SvTQCqqJUMQSwmGg",
      "state" : "SUCCESS",
      "include_global_state" : false,
      "shards_stats" : {
        "initializing" : 0,
        "started" : 0,
        "finalizing" : 0,
        "done" : 1,
        "failed" : 0,
        "total" : 1
      },
      "stats" : {
        "incremental" : {
          "file_count" : 3,
          "size_in_bytes" : 5969
        },
        "total" : {
          "file_count" : 4,
          "size_in_bytes" : 6024
        },
        "start_time_in_millis" : 1594829326691,
        "time_in_millis" : 205
      },
      "indices" : {
        "index_1" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 3,
              "size_in_bytes" : 5969
            },
            "total" : {
              "file_count" : 4,
              "size_in_bytes" : 6024
            },
            "start_time_in_millis" : 1594829326896,
            "time_in_millis" : 0
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 3,
                  "size_in_bytes" : 5969
                },
                "total" : {
                  "file_count" : 4,
                  "size_in_bytes" : 6024
                },
                "start_time_in_millis" : 1594829326896,
                "time_in_millis" : 0
              }
            }
          }
        }
      }
    }
  ]
}