Backup API
Export and import Celerp data.
Generated from the Celerp 2.4.0 OpenAPI schema, 16 September 2026.
GET /backup/export
Export Local
Export full local backup as .celerp-backup download.
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
Example
curl -X GET http://localhost:8000/backup/export \
-H "Authorization: Bearer $TOKEN"GET /backup/export/{backup_id}
Export Cloud
Download a cloud snapshot, rebuilt as a .celerp-backup archive.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
backup_id | path | yes | string | -- |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X GET http://localhost:8000/backup/export/:backup_id \
-H "Authorization: Bearer $TOKEN"POST /backup/import
Import Backup
Import a .celerp-backup file.
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/import \
-H "Authorization: Bearer $TOKEN"POST /backup/import-bootstrap
Import Backup Bootstrap
Import a .celerp-backup file when no users exist (setup wizard restore).
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/import-bootstrap \
-H "Authorization: Bearer $TOKEN"GET /backup/list
List Backups
List cloud snapshots. Returns a rendered HTML table on HTMX requests, else JSON. Returns the empty-state when the relay is not connected.
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
Example
curl -X GET http://localhost:8000/backup/list \
-H "Authorization: Bearer $TOKEN"POST /backup/restore/{backup_id}
Restore Backup
Restore a cloud snapshot (database + files) via the canonical importer.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
backup_id | path | yes | string | -- |
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
422 | Validation Error | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/restore/:backup_id \
-H "Authorization: Bearer $TOKEN"POST /backup/trigger
Trigger Backup
Run a cloud snapshot (database + files). Returns flash + HX-Trigger to refresh list.
Responses
| Status | Description | Body |
|---|---|---|
200 | Successful Response | -- |
Example
curl -X POST http://localhost:8000/backup/trigger \
-H "Authorization: Bearer $TOKEN"