---
title: "Restore from a backup"
method: POST
path: "/api/v1/admin/backup/{backup_id}/restore"
tags: ["backup"]
---

# Restore from a backup

`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
- TypeScript: <https://skmtc.dev/helena-bioinformatics/apis/helix-insight-variant-analysis-service/docs/api/v1/admin/backup/:backup_id/restore/post.ts> (a function with typed inputs; its response is checked against the schema)

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.

## Path parameters

- `backup_id` string, required

## Request body

- RestoreBackupRequest: Request to restore from a backup.
  - `confirm_backup_id` string, required: Must match the backup_id in the URL to confirm restore

## Response `202`

Successful Response

- RestoreStartedResponse: Response after initiating a restore.
  - `backup_id` string, required
  - `restore_id` string, required
  - `pre_restore_backup_id` string, required
  - `status` 'started' | 'running' | 'completed' | 'failed', required: Backup execution status.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/helena-bioinformatics/apis/helix-insight-variant-analysis-service.md) - [All operations](https://skmtc.dev/helena-bioinformatics/apis/helix-insight-variant-analysis-service/llms.txt) - [OpenAPI document](https://skmtc.dev/helena-bioinformatics/apis/helix-insight-variant-analysis-service/revisions/a800b0b27feb?raw)