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)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/helena-bioinformatics/apis/helix-insight-variant-analysis-service/docs/api/v1/admin/backup/post.ts
A function with typed inputs. Its response is checked against the schema.

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

Backup level enumeration.

Successful Response

backup_idstring required

status'started' | 'running' | 'completed' | 'failed' required

Backup execution status.

No recorded changes to this operation across all 6 revisions of this API.