Databases

A 15-minute download link (presigned URL) for one backup, after checking the dump is complete. Needs databases:reveal (owner/admin, or a developer on the database's project); audited. 409 with details.reason for missing, empty, incomplete or damaged dumps; 409 with details.verifying and Retry-After while a large dump is still being checked

post/databases/{databaseId}/backups/download

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/databases/{databaseId}/backups/download
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

databaseIdstring uuid required
Example:3f2b8a4e-5c1d-4e8f-9a7b-2c6d1e0f4a5b

Request body

executionIdstring required

id of a backup from GET /databases/{id}/backups/executions

Response

Download link

executionIdstring required
urlstring required

Presigned HTTPS GET URL of the backup file; no credentials needed, do not share it

expiresAtstring required

The URL works until then (start the download before)

downloadNamestring required

File name the browser saves it as

sizeBytesinteger required
format'postgresql' | 'sql' | 'mongodb' required
contentTypestring required
restoreHintstring required

how to restore the file by hand

Changes

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