NotAShelf
9e5eb41d39
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I4806c58aa0a17f504c9312723ad770166a6a6964
26 lines
575 B
Markdown
Vendored
26 lines
575 B
Markdown
Vendored
# Backup
|
|
|
|
Database backup
|
|
|
|
## Endpoints
|
|
|
|
### POST /api/v1/admin/backup
|
|
|
|
Create a database backup and return it as a downloadable file. POST
|
|
/api/v1/admin/backup
|
|
|
|
For `SQLite`: creates a backup via VACUUM INTO and returns the file. For
|
|
`PostgreSQL`: returns unsupported error (use `pg_dump` instead).
|
|
|
|
**Authentication:** Required (Bearer JWT)
|
|
|
|
#### Responses
|
|
|
|
| Status | Description |
|
|
| ------ | --------------------- |
|
|
| 200 | Backup file download |
|
|
| 401 | Unauthorized |
|
|
| 403 | Forbidden |
|
|
| 500 | Internal server error |
|
|
|
|
---
|