backups

Prepare a backup download

Creates a BackupDownload custom resource for the given restic snapshot. The operator materializes the file and fills in the pre-signed URL. Returns the existing download when one is already prepared, and 409 when two downloads are already being prepared.

post/api/projects/{projectName}/backups/{backupId}/download

Request

  • Base URL: https://api.hostim.dev
  • URL: https://api.hostim.dev/api/projects/{projectName}/backups/{backupId}/download
  • Auth: HTTP bearer

Path parameters

projectNamestring required

Name of the project

backupIdstring required

The restic short snapshot ID of the backup

Response

The download already exists

idstring required

The restic short snapshot ID of the backup

phasestring required

Pending, Running, Succeeded or Failed

fileNamestring required

The name of the prepared download file

sizeBytesinteger

The size of the prepared download file

urlstring

The pre-signed download URL, valid until expiresAt

expiresAtstring date-time

When the download URL stops working

errorstring

The reason the download failed

Changes

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