Using an Encryption Passphrase

Use the POST verb to start a direct download ad-hoc backup. You will want to supply a passphrase with your chosen encryption passphrase. It is possible to omit this, in which case the backup will still be encrypted, but it will decrypt given an empty passphrase.

Please see the section notes above about the long-running nature of this endpoint.

post/v1/backup

Response

Changes

Changed in 3 of the 54 revisions of this API.15

Dec 20, 2025022694254f0d1See the full diff
- ○
  api operation id Using an Encryption Passphrase removed and replaced with useEncryptionPassphrase
  api-operation-id-removed
Oct 27, 2025b11b54eea4872See the full diff
- ○
  added the media type application/zip for the response with the status 200
  response-media-type-added
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
Mar 13, 2025e8c2858fd4eb12See the full diff
- ▲
  removed the media type application/zip for the response with the status 200
  response-media-type-removed
- ○
  api operation id useEncryptionPassphrase removed and replaced with Using an Encryption Passphrase
  api-operation-id-removed
- ○
  added the non-success response with the status 403
  response-non-success-status-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history