Database - Snapshots
Restore Snapshot
Restore a database based on a snapshot of it.
POST
Restore Snapshot
string
required
The API key for your account. You can find this in your account settings.
snapshotId and versionId returned from Create Snapshot or List Snapshots. The snapshot’s engine must match the target database’s type, you cannot restore a Redis snapshot onto a MongoDB database, for example.
This overwrites the database’s current data with the snapshot’s contents; there is no undo beyond taking another snapshot first. While the restore is running, Start, Stop and Delete Database are rejected for that database. Rate limited to 1 restore per 60 seconds per user, and 1 restore per 120 seconds per database.
Parameters
string
required
The ID of the database.
string
required
The ID of the snapshot to restore for this database (database_id).
string
required
The version key of the snapshot.
Response
string
Indicates whether the call was successful..
success if successful, error if not.Common errors
Restore Snapshot

