backup

Start a new backup

Start a new platform backup.

Launches backup as a background task. Poll /backup/status/{backup_id} for progress.

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

post/api/v1/admin/backup

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
  • Auth: HTTP bearer

Request body

level'quick' | 'full' | 'complete'

Backup level enumeration.

Response

Successful Response

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.