Skip to content

Disaster Recovery Files

Disaster Recovery Files are automatic, encrypted backup archives of your data. Use this endpoint to list the available files and download them. For an overview of what the files contain and how they are produced, see the Disaster Recovery Files guide.

This endpoint is read-only. The platform generates the files automatically, so there are no create, update, or delete methods.

/backend/api/v1/disasterRecoveryFiles/ID - fetch the file with the specified ID.

This single endpoint returns either the file’s details or the file itself, depending on the Accept header you send:

  • JSON details: set Accept to application/json (or send no Accept header). The response is the file’s metadata.
  • The file: set Accept to application/x-7z-compressed. The response is the encrypted 7z archive itself.

/backend/api/v1/disasterRecoveryFiles/ - list all available files as JSON.

Only files that have not yet expired are returned. Once a file passes its expiry date it no longer appears, and requests for it return 404.

To download the archive, request a single file with the Accept header set to application/x-7z-compressed, and save the response to disk.

Terminal window
# List the available files and their IDs
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json" \
https://example.com/backend/api/v1/disasterRecoveryFiles/
# Download a specific file to disk
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/x-7z-compressed" \
-o backup.7z \
https://example.com/backend/api/v1/disasterRecoveryFiles/123

The downloaded archive is encrypted with a single platform-wide password. The API does not return this password. Get it from the web interface using the Request Archive Password action, which confirms your identity with two-factor authentication. See Getting the Archive Password.

You need data-protection download access to use this endpoint. Without it, requests are denied.

If a file cannot be found or has expired, the API returns 404 with error code 404102.

FieldNameTypeDescription
generatedDateGenerated DateDateThe date when this disaster recovery file was generated
expiresDateExpires DateDateThe date when this disaster recovery file expires and will no longer be available
idDisaster Recovery File IDTextThe unique identifier for this disaster recovery file
statusStatus FlagsPreset Value(s)
filenameFilenameTextThe filename of the disaster recovery file