| layout | page_title | description |
|---|---|---|
commands |
Commands: Snapshot Restore |
The `consul snapshot restore` command restores the state of Consul servers after a disaster. A server can restore key/value entries, registered services in the catalog, prepared queries, sessions, and ACLs from a saved snapshot.
|
Command: consul snapshot restore
Corresponding HTTP API Endpoint: [PUT] /v1/snapshot
The snapshot restore command is used to restore an atomic, point-in-time
snapshot of the state of the Consul servers which includes key/value entries,
service catalog, prepared queries, sessions, and ACLs. The snapshot is read
from the given file.
Restores involve a potentially dangerous low-level Raft operation that is not designed to handle server failures during a restore. This command is primarily intended to recover from a disaster. It restores your configuration into a fresh cluster of Consul servers as long as your new cluster runs the same Consul version as the cluster that originally took the snapshot.
The table below shows this command's required ACLs. Configuration of blocking queries and agent caching are not supported from commands, but may be from the corresponding HTTP endpoint.
| ACL Required |
|---|
management |
Usage: consul snapshot restore [options] FILE
@include 'http_api_options_client.mdx'
@include 'http_api_options_server.mdx'
To restore a snapshot from the file "backup.snap":
$ consul snapshot restore backup.snap
Restored snapshot
Please see the HTTP API documentation for more details about snapshot internals.