Backup API
Backup and restore API for exporting, importing, listing, creating, and restoring Celerp ERP backups.
Generated from the Celerp 2.8.0 OpenAPI schema, 2 November 2026.
GET /backup/export
Export Local Celerp Backup
Export a complete local Celerp backup as a .celerp-backup download.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the generated file or download response. | -- |
Example
curl -X GET http://localhost:8000/backup/export \
-H "Authorization: Bearer $TOKEN"GET /backup/export/{backup_id}
Download Cloud Backup
Download the selected cloud backup as a portable .celerp-backup archive.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
backup_id | path | yes | string | Identifier of the backup snapshot. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the generated file or download response. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X GET http://localhost:8000/backup/export/:backup_id \
-H "Authorization: Bearer $TOKEN"POST /backup/import
Import Celerp Backup
Import a .celerp-backup archive into the current Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the restore outcome and any warnings. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/import \
-H "Authorization: Bearer $TOKEN"POST /backup/import-bootstrap
Restore Backup During Initial Setup
Restore a .celerp-backup archive during first-time setup before user accounts exist.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns `ok: true`, the restored company name, any warnings, and whether a restart has been scheduled. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/import-bootstrap \
-H "Authorization: Bearer $TOKEN"POST /backup/import/continue
Continue Backup Import Without Safety Copy
Restore a staged recovery without a safety copy, after the owner confirmed. It continues an import that stopped because no safety copy could be made, using the confirmation ID and archive digest that import returned. The confirmation expires and can be used once.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns an HTML fragment with the restore outcome. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/import/continue \
-H "Authorization: Bearer $TOKEN"GET /backup/list
List Cloud Backups
Return the available cloud backup snapshots for this Celerp installation.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the requested cloud backups. | -- |
Example
curl -X GET http://localhost:8000/backup/list \
-H "Authorization: Bearer $TOKEN"POST /backup/restore/{backup_id}
Restore Cloud Backup
Restore the selected cloud backup, including its database and stored files.
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
backup_id | path | yes | string | Identifier of the backup snapshot. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the restore outcome and any warnings. | -- |
422 | The request failed validation. The response lists each invalid field and why. | HTTPValidationError |
Example
curl -X POST http://localhost:8000/backup/restore/:backup_id \
-H "Authorization: Bearer $TOKEN"POST /backup/trigger
Create Cloud Backup
Create a new cloud backup of the current Celerp database and stored files.
Responses
| Status | Description | Body |
|---|---|---|
200 | Returns the created cloud backup or creation result. | -- |
Example
curl -X POST http://localhost:8000/backup/trigger \
-H "Authorization: Bearer $TOKEN"