Restore backup
Backups
Restore backup
Restore a database from an existing backup.
POST
Restore backup
Restores a database from an existing backup file. This overwrites all data in the target database with the contents of the backup.
Path parameters
| Parameter | Type | Description |
|---|---|---|
id | uuid | Database ID |
filename | string | Backup filename (format: YYYYMMDD_HHMMSS.sql.gz) |
Example
Response
200 OK
Errors
| Status | Code | Description |
|---|---|---|
| 400 | INVALID_BACKUP_FILENAME | Filename doesn’t match the expected YYYYMMDD_HHMMSS.sql.gz format |
| 401 | UNAUTHORIZED | Missing or invalid API key |
| 404 | DATABASE_NOT_FOUND | Database doesn’t exist, isn’t owned by this user, or isn’t in scope for this key |
| 404 | BACKUP_NOT_FOUND | Backup file not found |
| 503 | AGENT_ROUTE_UNAVAILABLE | The VPS agent doesn’t support restore yet (needs update) |
| 500 | AGENT_ERROR | The VPS agent failed to restore the backup |