Direct Backup

Using an Encryption Passphrase

Changed on

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

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/backup
  • Auth
    none declared

Request body */*

passphrasestring

The passphrase with which to encrypt the backup.

Example request

{
  "passphrase": "my-password"
}

Response

OK

Changes

  • 022694254f0dRevision changes
    • info

      api operation id Using an Encryption Passphrase removed and replaced with useEncryptionPassphrase

  • b11b54eea487Revision changes
    • info

      added the media type application/zip for the response with the status

    • info

      removed the non-success response with the status