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

• active_only boolean

  If true, the response only includes ongoing shard recoveries.

• detailed boolean

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

Responses

• 200 application/json
  Hide response attribute Show response attribute object

  • * object Additional properties

    Additional properties are allowed.

    Hide * attribute Show * attribute object

    • shards array[object] Required
      Hide shards attributes Show shards attributes object

      • id number Required
      • index object Required

        Additional properties are allowed.

        Hide index attributes Show index attributes object

        • bytes object

          Additional properties are allowed.

          Hide bytes attributes Show bytes attributes object

          • percent
          • recovered
          • recovered_in_bytes
          • recovered_from_snapshot
          • recovered_from_snapshot_in_bytes
          • reused
          • reused_in_bytes
          • total
          • total_in_bytes
        • files object Required

          Additional properties are allowed.

          Hide files attributes Show files attributes object

          • details array[object]
          • percent
          • recovered number Required
          • reused number Required
          • total number Required
        • size object Required

          Additional properties are allowed.

          Hide size attributes Show size attributes object

          • percent
          • recovered
          • recovered_in_bytes
          • recovered_from_snapshot
          • recovered_from_snapshot_in_bytes
          • reused
          • reused_in_bytes
          • total
          • total_in_bytes
        • source_throttle_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.

        • source_throttle_time_in_millis number

          Time unit for milliseconds

        • target_throttle_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.

        • target_throttle_time_in_millis number

          Time unit for milliseconds

        • total_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.

        • total_time_in_millis number

          Time unit for milliseconds

      • primary boolean Required
      • source object Required

        Additional properties are allowed.

        Hide source attributes Show source attributes object

        • hostname string
        • host string
        • transport_address string
        • id string
        • ip string
        • name string
        • bootstrap_new_history_uuid boolean
        • repository string
        • snapshot string
        • version string
        • restoreUUID string
        • index string
      • stage string Required
      • start object

        Additional properties are allowed.

        Hide start attributes Show start attributes object

        • check_index_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.

        • check_index_time_in_millis number

          Time unit for milliseconds

        • total_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.

        • total_time_in_millis number

          Time unit for milliseconds

      • start_time string | number

        A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

        One of:

        _types:DateTime string _types:UnitMillis number

        Time unit for milliseconds

      • start_time_in_millis number

        Time unit for milliseconds

      • stop_time string | number

        A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.

        One of:

        _types:DateTime string _types:UnitMillis number

        Time unit for milliseconds

      • stop_time_in_millis number

        Time unit for milliseconds

      • target object Required

        Additional properties are allowed.

        Hide target attributes Show target attributes object

        • hostname string
        • host string
        • transport_address string
        • id string
        • ip string
        • name string
        • bootstrap_new_history_uuid boolean
        • repository string
        • snapshot string
        • version string
        • restoreUUID string
        • index string
      • total_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.

      • total_time_in_millis number

        Time unit for milliseconds

      • translog object Required

        Additional properties are allowed.

        Hide translog attributes Show translog attributes object

        • percent string | number Required

          One of:

          _types:Percentage string _types:Percentage number
        • recovered number Required
        • total number Required
        • total_on_start number Required
        • total_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.

        • total_time_in_millis number

          Time unit for milliseconds

      • type string Required
      • verify_index object Required

        Additional properties are allowed.

        Hide verify_index attributes Show verify_index attributes object

        • check_index_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.

        • check_index_time_in_millis number

          Time unit for milliseconds

        • total_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.

        • total_time_in_millis number

          Time unit for milliseconds