List external database backups
Retrieve the external backups of a database across all of its backup targets. External backups are dump files stored in the backup target buckets; the bucket content is the source of truth, so this endpoint lists the buckets live. Databases without backup targets return an empty list. A target whose bucket cannot be listed, for example because its credentials were revoked, is skipped. 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"
Query Parameters
Filter backups by type. automatic matches scheduled backups, manual matches user-created backups. When omitted, both are returned.
automatic, manual Response
Default Response
External backup identifier, the dump file name in the backup target bucket
"20250115-013000_manual_pg17_my-backup.sql.gz"
Human-readable name for the backup. Manual backups use the name given at creation, automatic backups use the backup target name.
"My Manual Backup"
Backup type. automatic - created by the backup target schedule, pruned after the target retention days. manual - user-created, pruned after the target manual retention days.
automatic, manual "manual"
Backup file format. sql_dump - gzip-compressed SQL dump (postgresql, mysql, mariadb). rdb_dump - gzip-compressed RDB file (redis, valkey).
sql_dump, rdb_dump "sql_dump"
Size of the backup file in bytes
4830
Version of the database engine the backup was taken from
"17"
Identifier of the backup target holding this backup
^([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"
Timestamp when the backup was created, in ISO 8601 format
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2025-01-30T00:00:00.000Z"
Timestamp when the backup expires and gets pruned from the bucket, in ISO 8601 format. Null when the backup is kept forever, which happens for manual backups on a target with manual retention set to 0.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$"2025-02-06T00:00:00.000Z"