Skip to main content

Backups

World-save backup CRUD and schedule settings.

BackupsController​

  • Route prefix: api/backups
  • Auth: All endpoints require admin role.
MethodPathDescriptionRequestResponse
GET/List all backup recordsBackupRecord[]
POST/Create manual backup{ notes }BackupRecord
POST/{id}/restoreRestore from a backup (creates a safety backup first)string
DELETE/{id}Delete backup file and recordstring
GET/settingsCurrent schedule settingsBackupSettings
PUT/settingsUpdate schedule settings{ intervalMinutes, maxBackups, backupPath }string

Notes​

  • BackupRecord fields: { id, filename, worldName, size, createdAt, type, notes }. type is one of manual, scheduled, restore.
  • Restore creates a restore-point backup of the current state before rolling back, so a bad restore is itself recoverable.
  • maxBackups pruning applies after successful scheduled or manual Create. Restore points don't count toward the limit.