Backup

Backup

This endpoint exports an encrypted backup.

Export a backup

Exports an encrypted backup.

POST /api/v2/backup/export

Arguments:

  • key - (Optional) A valid encryption key for the backup; must be 64 characters long and consist only of lowercase (a-z), uppercase (A-Z), and numeric (0-9) characters. If a key is not provided in the request, a randomly generated key will be used and provided in the response header.

Response:

  • A backup export file tagged with current version and timestamp.

If a key is not provided in the request, a generated key will be provided in the response header X-JackDB-Backup-Key.

Example request:

$ curl \
    -H "Accept: application/vnd.jackdb.v2+json" \
    -u "${JACKDB_API_KEY_ID}@api:${JACKDB_API_KEY_SECRET}" \
    -X POST \
    "${JACKDB_API_URL}/backup/export"

Example response:

***binary data***