[[reference-indices-recovery]]

////////
===========================================================================================================================
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
||        ██████╗ ███████╗ █████╗ ██████╗ ███╗   ███╗███████╗                                                            ||
||        ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝                                                            ||
||        ██████╔╝█████╗  ███████║██║  ██║██╔████╔██║█████╗                                                              ||
||        ██╔══██╗██╔══╝  ██╔══██║██║  ██║██║╚██╔╝██║██╔══╝                                                              ||
||        ██║  ██║███████╗██║  ██║██████╔╝██║ ╚═╝ ██║███████╗                                                            ||
||        ╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝╚═════╝ ╚═╝     ╚═╝╚══════╝                                                            ||
||                                                                                                                       ||
||                                                                                                                       ||
||    This file is autogenerated, DO NOT send pull requests that changes this file directly.                             ||
||    You should update the script that does the generation, which can be found in:                                      ||
||    https://github.com/elastic/elastic-client-generator-js                                                             ||
||                                                                                                                       ||
||    You can run the script with the following command:                                                                 ||
||       npm run elasticsearch -- --version <version>                                                                    ||
||                                                                                                                       ||
||                                                                                                                       ||
||                                                                                                                       ||
===========================================================================================================================
////////

[discrete]
[[client.indices.recovery]]
=== client.indices.recovery

Returns information about ongoing and completed shard recoveries for one or more indices. For data streams, the API returns information for the stream’s backing indices.

{ref}/indices-recovery.html[{es} documentation]

[discrete]
==== Function signature

[source,ts]
----
(IndicesRecoveryRequest, options?): Promise<IndicesRecoveryResponse>
----

[discrete]
==== IndicesRecoveryRequest

[pass]
++++
<pre>
++++
interface IndicesRecoveryRequest extends <<RequestBase>> {
  index?: <<Indices>>
  active_only?: boolean
  detailed?: boolean
}

[pass]
++++
</pre>
++++
[discrete]
==== IndicesRecoveryResponse

[pass]
++++
<pre>
++++
type IndicesRecoveryResponse = Record<<<IndexName>>, IndicesRecoveryRecoveryStatus>

[pass]
++++
</pre>
++++