WordPress

A 15-minute download link (presigned URL) for a backup dump; the dump is copied to platform storage and reused for 24 hours. Needs databases:reveal (owner/admin, or a developer on the project). 409 with Retry-After while a large dump is still being copied

post/projects/{projectId}/wordpress/backups/download

Request

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

Path parameters

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

Request body

filenamestring required

A backup filename from GET /projects/{projectId}/wordpress/backups (<timestamp>.sql.gz)

Response

Download link

filenamestring required
urlstring required

Presigned HTTPS GET URL of the gzipped SQL dump; 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
contentType'application/gzip' required
availableUntilstring required

The prepared copy is deleted then; asking again after that prepares a new one

preparedboolean required

true when this request copied the backup; false when an existing copy was reused

Changes

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