backup

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)
  • URL: https://api.helena.bio/api/v1/admin/backup/status/{backup_id}
  • Auth: HTTP bearer

Path parameters

backup_idstring required

Response

Successful Response

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

Backup execution status.

progressinteger

Progress percentage

current_stepstring
errorstring nullable

Changes

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