Returns information about the status of a snapshot Added in 7.8.0

GET /_snapshot/_status

Query parameters

  • ignore_unavailable boolean

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

  • master_timeout string

    Explicit operation timeout for connection to master node

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • snapshots array[object] Required
      Hide snapshots attributes Show snapshots attributes object
      • include_global_state boolean Required
      • indices object Required
        Hide indices attribute Show indices attribute object
        • * object Additional properties

          Additional properties are allowed.

          Hide * attributes Show * attributes object
          • shards object Required
            Hide shards attribute Show shards attribute object
            • * object Additional properties

              Additional properties are allowed.

          • shards_stats object Required

            Additional properties are allowed.

            Hide shards_stats attributes Show shards_stats attributes object
          • stats object Required

            Additional properties are allowed.

            Hide stats attributes Show stats attributes object
            • incremental object Required

              Additional properties are allowed.

            • start_time_in_millis
            • time string

              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_in_millis
            • total object Required

              Additional properties are allowed.

      • repository string Required
      • shards_stats object Required

        Additional properties are allowed.

        Hide shards_stats attributes Show shards_stats attributes object
      • snapshot string Required
      • state string Required
      • stats object Required

        Additional properties are allowed.

        Hide stats attributes Show stats attributes object
        • incremental object Required

          Additional properties are allowed.

          Hide incremental attributes Show incremental attributes object
        • start_time_in_millis number

          Time unit for milliseconds

        • time string

          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_in_millis number

          Time unit for milliseconds

        • total object Required

          Additional properties are allowed.

          Hide total attributes Show total attributes object
      • uuid string Required
GET /_snapshot/_status 
curl \
 -X GET http://api.example.com/_snapshot/_status
Response examples (200) 
{
  "snapshots": [
    {
      "include_global_state": true,
      "indices": {
        "additionalProperty1": {
          "shards": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "shards_stats": {
            "done": 42.0,
            "failed": 42.0,
            "finalizing": 42.0,
            "initializing": 42.0,
            "started": 42.0,
            "total": 42.0
          },
          "stats": {
            "incremental": {},
            "time": "string",
            "total": {}
          }
        },
        "additionalProperty2": {
          "shards": {
            "additionalProperty1": {},
            "additionalProperty2": {}
          },
          "shards_stats": {
            "done": 42.0,
            "failed": 42.0,
            "finalizing": 42.0,
            "initializing": 42.0,
            "started": 42.0,
            "total": 42.0
          },
          "stats": {
            "incremental": {},
            "time": "string",
            "total": {}
          }
        }
      },
      "repository": "string",
      "shards_stats": {
        "done": 42.0,
        "failed": 42.0,
        "finalizing": 42.0,
        "initializing": 42.0,
        "started": 42.0,
        "total": 42.0
      },
      "snapshot": "string",
      "state": "string",
      "stats": {
        "incremental": {
          "file_count": 42.0,
          "size_in_bytes": 42.0
        },
        "": 42.0,
        "time": "string",
        "total": {
          "file_count": 42.0,
          "size_in_bytes": 42.0
        }
      },
      "uuid": "string"
    }
  ]
}