Cluster Backups

Get a one-time download link for a backup

Issues a link that downloads a completed backup once, within about 15 minutes. The download is the PostgreSQL custom-format archive of the cluster's database; restore it with pg_restore. Every download is recorded in the audit log.

A managed backup always contains credentials, so include_credentials must be true (it defaults to false); otherwise the request is refused with 422. Returns 409 for a backup that is not completed or has expired.

Required scope: clusters:backups:write

post/clusters/{cluster_id}/backups/{backup_id}/download-link

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/clusters/{cluster_id}/backups/{backup_id}/download-link
  • Auth: API key in header API-Key

Path parameters

cluster_idstring uuid required
backup_idstring required

Backup identifier: auto-<yyyymmddhhmm> for an automatic backup, manual-<timestamp>-<suffix> for an on-demand one.

Headers

API-Version'2026-06-01.beta' required

Request body

include_credentialsboolean

A managed backup is a complete database backup, so it always contains credentials (user password hashes, client secrets). Must be true to download; defaults to false like the export option.

Response

The request has succeeded and a new resource has been created as a result.

urlstring uri required

One-time download URL. It works once and expires at expires_at, about 15 minutes after it is issued. The download is the PostgreSQL custom-format archive (pg_restore).

expires_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.