backup

Restore from a backup

Restore platform from a backup.

DESTRUCTIVE OPERATION:

  • Overwrites current PostgreSQL data
  • Replaces session outputs
  • Replaces literature/reference databases (if present in backup)

Safety measures:

  • confirm_backup_id must match the URL backup_id
  • A pre-restore quick backup is created automatically
  • Only successful backups can be restored

Requires admin role. Only one operation can run at a time.

post/api/v1/admin/backup/{backup_id}/restore

Request

  • Base URL: https://api.helena.bio (the document declares no server; this is the origin it was published from)
  • URL: https://api.helena.bio/api/v1/admin/backup/{backup_id}/restore
  • Auth: HTTP bearer

Path parameters

backup_idstring required

Request body

confirm_backup_idstring required

Must match the backup_id in the URL to confirm restore

Response

Successful Response

backup_idstring required
restore_idstring required
pre_restore_backup_idstring required
status'started' | 'running' | 'completed' | 'failed' required

Backup execution status.

Changes

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