Returns information about ongoing and completed shard recoveries for one or more indices

GET /{index}/_recovery

For data streams, the API returns information for the stream’s backing indices.

Path parameters

  • index string | array[string] Required

    Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Query parameters

  • If true, the response only includes ongoing shard recoveries.

  • detailed boolean

    If true, the response includes detailed information about shard recoveries.

Responses

GET /{index}/_recovery
curl \
 -X GET http://api.example.com/{index}/_recovery
Response examples (200)
{
  "additionalProperty1": {
    "shards": [
      {
        "id": 42.0,
        "index": {
          "bytes": {},
          "files": {
            "details": [
              {}
            ],
            "recovered": 42.0,
            "reused": 42.0,
            "total": 42.0
          },
          "size": {},
          "source_throttle_time": "string",
          "": 42.0,
          "target_throttle_time": "string",
          "total_time": "string"
        },
        "primary": true,
        "source": {
          "hostname": "string",
          "host": "string",
          "transport_address": "string",
          "id": "string",
          "ip": "string",
          "name": "string",
          "bootstrap_new_history_uuid": true,
          "repository": "string",
          "snapshot": "string",
          "version": "string",
          "restoreUUID": "string",
          "index": "string"
        },
        "stage": "string",
        "start": {
          "check_index_time": "string",
          "": 42.0,
          "total_time": "string"
        },
        "": 42.0,
        "target": {
          "hostname": "string",
          "host": "string",
          "transport_address": "string",
          "id": "string",
          "ip": "string",
          "name": "string",
          "bootstrap_new_history_uuid": true,
          "repository": "string",
          "snapshot": "string",
          "version": "string",
          "restoreUUID": "string",
          "index": "string"
        },
        "total_time": "string",
        "translog": {
          "": 42.0,
          "recovered": 42.0,
          "total": 42.0,
          "total_on_start": 42.0,
          "total_time": "string"
        },
        "type": "string",
        "verify_index": {
          "check_index_time": "string",
          "": 42.0,
          "total_time": "string"
        }
      }
    ]
  },
  "additionalProperty2": {
    "shards": [
      {
        "id": 42.0,
        "index": {
          "bytes": {},
          "files": {
            "details": [
              {}
            ],
            "recovered": 42.0,
            "reused": 42.0,
            "total": 42.0
          },
          "size": {},
          "source_throttle_time": "string",
          "": 42.0,
          "target_throttle_time": "string",
          "total_time": "string"
        },
        "primary": true,
        "source": {
          "hostname": "string",
          "host": "string",
          "transport_address": "string",
          "id": "string",
          "ip": "string",
          "name": "string",
          "bootstrap_new_history_uuid": true,
          "repository": "string",
          "snapshot": "string",
          "version": "string",
          "restoreUUID": "string",
          "index": "string"
        },
        "stage": "string",
        "start": {
          "check_index_time": "string",
          "": 42.0,
          "total_time": "string"
        },
        "": 42.0,
        "target": {
          "hostname": "string",
          "host": "string",
          "transport_address": "string",
          "id": "string",
          "ip": "string",
          "name": "string",
          "bootstrap_new_history_uuid": true,
          "repository": "string",
          "snapshot": "string",
          "version": "string",
          "restoreUUID": "string",
          "index": "string"
        },
        "total_time": "string",
        "translog": {
          "": 42.0,
          "recovered": 42.0,
          "total": 42.0,
          "total_on_start": 42.0,
          "total_time": "string"
        },
        "type": "string",
        "verify_index": {
          "check_index_time": "string",
          "": 42.0,
          "total_time": "string"
        }
      }
    ]
  }
}