Backup Commands
How to create, manage, and restore world backups
Edit on GitHubBackup Commands
World backup commands allow you to create, manage, and restore backups of your worlds.
/world backup create
Creates a backup of one or more worlds.
Usage: /world backup create <world> [<name>]
Permission: worlds.command.backup.create
See the Permissions page for all command permissions.
Arguments
<world>- The world to backup, or*to backup all worlds[<name>]- Optional custom name for the backup. If not specified, uses the patternyyyy-MM-dd_HH-mm-ss.zip
Backup Location
Backups are stored in the backup folder, which can be configured using:
- Environment variable:
WORLDS_BACKUP_FOLDER - System property:
worlds.backup.folder - Default location:
…/backups/<world-name>/
For example, backups for a world named "myworld" would be stored in …/backups/myworld/ by default.
The default location is relative to the server's world container folder which can be changed.
Examples
Create a backup with automatic timestamp name:
/world backup create worlds:survivalCreate a backup with a custom name:
/world backup create worlds:survival pre-update-backupBackup all worlds at once:
/world backup create *Backup all worlds with a custom name:
/world backup create * weekly-backup/world backup delete
Deletes a specific backup.
Usage: /world backup delete <world> <backup>
Permission: worlds.command.backup.delete
Arguments
<world>- The world whose backup you want to delete<backup>- The name of the backup to delete
Example
Delete a specific backup:
/world backup delete worlds:survival 2024-01-15_14-30-00.zip/world backup list
Lists all backups for a world, sorted by age from most recent to oldest.
Usage: /world backup list <world>
Permission: worlds.command.backup.list
Arguments
<world>- The world whose backups you want to list
Information Displayed
The list command shows for each backup:
- Backup Name - The name of the backup file
- Age - How long ago the backup was created
- Size - The size of the backup on disk
Backup entries in the list are interactive! Hover over a backup to see quick actions, and click to quickly restore or delete backups.
Example
List all backups for a world:
/world backup list worlds:survival/world backup restore
Restores a world from a backup.
Usage: /world backup restore <world> <backup>
Permission: worlds.command.backup.restore
Arguments
<world>- The world to restore<backup>- The backup to restore from, orlatestto restore the most recent backup
Examples
Restore the most recent backup:
/world backup restore worlds:survival latestRestore a specific backup:
/world backup restore worlds:survival pre-update-backup.zipRestoring a backup will replace the current world data. Make sure to create a backup of the current state before restoring if needed.
Use Cases
Regular Backups
Create automated backups before major changes:
/world backup create worlds:survival before-eventDisaster Recovery
Restore a world after corruption or unwanted changes:
# List available backups
/world backup list worlds:survival
# Restore the most recent backup
/world backup restore worlds:survival latestServer Maintenance
Backup all worlds before a server update:
/world backup create * pre-1.21-updateCleanup Old Backups
Remove outdated backups to save disk space:
# List backups to find old ones
/world backup list worlds:survival
# Delete specific old backups
/world backup delete worlds:survival 2023-12-01_10-00-00Testing and Experimentation
Create a backup before testing new features:
/world backup create worlds:creative before-testing
# Test your changes...
# Restore if needed
/world backup restore worlds:creative before-testingLast updated on