Restore external database backup
Restore a database from an external backup. The dump file is downloaded from the backup target bucket and replayed into the database asynchronously - the database status reflects the progress and ends in ready, or restoringFailed when the replay fails. The destination data is replaced by the backup content. By default the source database is restored in place. Optionally pass target_database_id to restore into a different database of the same type in the same cluster. Restores are attempted regardless of engine version; an incompatible dump fails the restore. Rejected with a 400 while another restore is in progress on the destination. Databases that do not support external backups return a 400.
Authorizations
API key authentication. Pass your API key as a Bearer token in the Authorization header.
Path Parameters
Database identifier
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
External backup identifier from the backup list
"20250115-013000_manual_pg17_my-backup.sql.gz"
Body
Optional ID of a different database to restore the backup into. When provided, the backup is restored into this database instead of the source. The target must be in the same cluster and of the same database type as the source. Its current data will be replaced.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"fb5e5168-4281-4bec-94c5-0d1584e9e657"
Response
Default Response
Confirmation message
"External database backup restore started"