Backups
World-save backup CRUD and schedule settings.
BackupsController
- Route prefix:
api/backups - Auth: All endpoints require admin role.
| Method | Path | Description | Request | Response |
|---|---|---|---|---|
| GET | / | List all backup records | BackupRecord[] | |
| POST | / | Create manual backup | { notes } | BackupRecord |
| POST | /{id}/restore | Restore from a backup (creates a safety backup first) | string | |
| DELETE | /{id} | Delete backup file and record | string | |
| GET | /settings | Current schedule settings | BackupSettings | |
| PUT | /settings | Update schedule settings | { intervalMinutes, maxBackups, backupPath } | string |
Notes
BackupRecordfields:{ id, filename, worldName, size, createdAt, type, notes }.typeis one ofmanual,scheduled,restore.- Restore creates a restore-point backup of the current state before rolling back, so a bad restore is itself recoverable.
maxBackupspruning applies after successful scheduled or manual Create. Restore points don't count toward the limit.