anchor.diff:  [[cat-recovery]]
   === cat recovery
   
  -The `recovery` command is a view of index shard recoveries, both on-going and previously
  -completed. It is a more compact view of the JSON <<indices-recovery,recovery>> API.
  +Returns information about ongoing and completed index shard recoveries, similar
  +to the <<indices-recovery, indices recovery>> API.
   
  -A recovery event occurs anytime an index shard moves to a different node in the cluster.
  -This can happen during a snapshot recovery, a change in replication level, node failure, or
  -on node startup. This last type is called a local store recovery and is the normal
  -way for shards to be loaded from disk when a node starts up.
   
  -As an example, here is what the recovery state of a cluster may look like when there
  -are no shards in transit from one node to another:
  +[[cat-recovery-api-request]]
  +==== {api-request-title}
  +
  +`GET /_cat/recovery/{index}`
  +
  +
  +[[cat-recovery-api-desc]]
  +==== {api-description-title}
  +
  +The cat recovery API returns information about index shard recoveries, both
  +ongoing and completed. It is a more compact view of the JSON
  +<<indices-recovery,indices recovery>> API.
  +
  +A recovery event occurs anytime an index shard moves to a different node in the
  +cluster. This can happen during a snapshot recovery, a change in replication
  +level, node failure, or on node startup. This last type is called a local store
  +recovery and is the normal way for shards to be loaded from disk when a node
  +starts up.
  +
  +
  +[[cat-recovery-path-params]]
  +==== {api-path-parms-title}
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
  +
  +
  +[[cat-recovery-query-params]]
  +==== {api-query-parms-title}
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=bytes]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
  +
  +include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
  +
  +
  +[[cat-recovery-api-example]]
  +==== {api-examples-title}
  +
  +[[cat-recovery-api-ex-dead]]
  +===== Example with no ongoing recoveries
   
   [source,js]
   ----------------------------------------------------------------------------
  
positive.code: // TESTRESPONSE[s/100.0%/0.0%/]
  // TESTRESPONSE[s/1252ms/[0-9.]+m?s/ non_json]
  
  We can see in the above listing that our thw twitter shard was recovered from another node.
  Notice that the recovery type is shown as `peer`. The files and bytes copied are
  real-time measurements.
  
  Finally, let's see what a snapshot recovery looks like. Assuming I have previously
  made a backup of my index, I can restore it using the <<modules-snapshots,snapshot and restore>>
  API.
  
  [source,js]
  --------------------------------------------------------------------------------
  
negative.code: // CONSOLE
  // TEST[setup:twitter]
  
  The API returns the following response:
  
  [source,txt]
  ----------------------------------------------------------------------------
  