Platform
Backups and restore
Back up the save folders your game definition declares, on demand or on a schedule, and restore a server in place with an automatic safety copy.
Taking backups
A backup captures the save folders your game definition declares, with a checksum. You can take one at any time from the studio app or the API.
Schedules and retention
Scheduled backups are set per server. Out of the box, a server is backed up on this schedule, and you can change every value:
- every 6 hours
- keeping the latest 4 backups
- plus one a day for 7 days, one a week for 4 weeks and one a month for 6 months
A backup you want to keep regardless of the schedule can be locked against deletion.
Restoring
Restoring puts a backup back onto the server it came from. Before anything is overwritten, the platform takes a safety backup of the server as it is, and if the restore fails it rolls back to that copy.
A restore moves through these steps, which you can follow as it runs: safety_backup, stopping, downloading, verifying, restoring, reconfiguring and starting.
Download and import
- Download any backup as an archive. Each download link is valid for 5 minutes.
- Import a world archive into a server. Downloading from one server and importing into another is how you move save data between servers.
Knowing a backup ran
Finished and failed backups raise the backup.completed and backup.failed webhooks, and a failed backup raises an alert. See Monitoring, logs and alerts and Webhooks.