Get backup or restore status

Poll backup/restore execution status.

Returns current progress, step name, and any error. Works for both backup_id and restore_id. Accessible to all authenticated users.

get/api/v1/admin/backup/status/{backup_id}

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/status/:backup_id/get.ts
A function with typed inputs. Its response is checked against the schema.

backup_idstring required

Successful Response

backup_idstring required

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

Backup execution status.

progressinteger

Progress percentage

current_stepstring

errorstring nullable

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