miagilepner 9b42318e44
VAULT-34525: Documentation for single item recovery from IS snapshot (#30739)
* start

* docs

* everything except the concept doc

* actual progress

* thank you copilot for finding passive voice

* formatting

* add changelog

* fix formatting of changelog

* update changelog

* Update website/content/api-docs/secret/cubbyhole.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/cubbyhole.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/cubbyhole.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/cubbyhole.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/kv/kv-v1.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/cubbyhole.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/docs/concepts/integrated-storage/snapshot-recover.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/cubbyhole.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/kv/kv-v1.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Update website/content/api-docs/secret/kv/kv-v1.mdx

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>

* more fixes

* remove example usage

---------

Co-authored-by: Sarah Chavis <62406755+schavis@users.noreply.github.com>
2025-06-11 15:50:24 +02:00

35 lines
903 B
Plaintext

---
layout: docs
page_title: recover - Command
description: |-
Use the recover command to pull data from a loaded snapshot and restore it at
the specified path.
---
# recover
@include 'alerts/enterprise-only.mdx'
The `recover` command pulls data at the specified path from a loaded snapshot
and restores it to the cluster, overwriting newer data on the same path.
@include 'recover/deletedmounts.mdx'
## Examples
Recover the KV version 1 secret at the path `my-secret` from the loaded snapshot with ID `2403d301-94f2-46a1-a39d-02be83e2831a`:
```shell-session
$ vault recover -snapshot-id=2403d301-94f2-46a1-a39d-02be83e2831a secret/my-secret
```
## Usage
The following flag is available in addition to the [standard set of
flags](/vault/docs/commands) included on all commands.
### Command options
- `snapshot-id` `(string: "")` - Specifies a loaded snapshot ID to recover
the data from.