Create external database backup
Create a manual external backup of a database. The database is dumped and the file is uploaded to the backup target bucket asynchronously; the backup appears in the external backup list once the upload completes. Requires at least one backup target attached to the database, otherwise a 400 is returned. A target can hold at most 5 manual backups. The database and its backups must be in a ready state. 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"
Body
Human-readable name for the manual backup
1 - 200"Pre-migration backup"
Identifier of the backup target to upload the backup to. Required when the database has more than one backup target. When the database has exactly one target, it is used automatically.
^([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 creation started"