Skip to main content
GET
List external database backups

Authorizations

Authorization
string
header
required

API key authentication. Pass your API key as a Bearer token in the Authorization header.

Path Parameters

id
string<uuid>
required

Database identifier

Pattern: ^([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)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

Query Parameters

type
enum<string>

Filter backups by type. automatic matches scheduled backups, manual matches user-created backups. When omitted, both are returned.

Available options:
automatic,
manual

Response

Default Response

id
string
required

External backup identifier, the dump file name in the backup target bucket

Example:

"20250115-013000_manual_pg17_my-backup.sql.gz"

display_name
string
required

Human-readable name for the backup. Manual backups use the name given at creation, automatic backups use the backup target name.

Example:

"My Manual Backup"

type
enum<string>
required

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.

Available options:
automatic,
manual
Example:

"manual"

format
enum<string>
required

Backup file format. sql_dump - gzip-compressed SQL dump (postgresql, mysql, mariadb). rdb_dump - gzip-compressed RDB file (redis, valkey).

Available options:
sql_dump,
rdb_dump
Example:

"sql_dump"

size_bytes
number
required

Size of the backup file in bytes

Example:

4830

engine_version
string
required

Version of the database engine the backup was taken from

Example:

"17"

target_id
string<uuid>
required

Identifier of the backup target holding this backup

Pattern: ^([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)$
Example:

"fb5e5168-4281-4bec-94c5-0d1584e9e657"

created_at
string<date-time>
required

Timestamp when the backup was created, in ISO 8601 format

Pattern: ^(?:(?:\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))$
Example:

"2025-01-30T00:00:00.000Z"

expires_at
string<date-time> | null
required

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.

Pattern: ^(?:(?:\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))$
Example:

"2025-02-06T00:00:00.000Z"