Backup Commands
How to create, manage, and restore world backups
Edit on GitHubBackup Commands
World backup commands allow you to create, list, restore, delete, and prune backups.
/world backup create
Creates a backup of one or more worlds.
Usage:
/world backup create *
/world backup create [<world>] [<name>]Permission: worlds.command.backup.create
See the Permissions page for all command permissions.
create without a world backs up the sender's current world.
create <world> backs up one world.
create <world> <name> creates a named backup.
create * backs up all loaded worlds.
Examples
/world backup create
/world backup create example:survival
/world backup create example:survival pre-update
/world backup create */world backup list
Lists backups.
Usage:
/world backup list [<world>]Permission: worlds.command.backup.list
list lists backups for all worlds.
list <world> lists backups for one world.
Examples
/world backup list
/world backup list example:survival/world backup delete
Deletes a specific backup.
Usage: /world backup delete <world> <backup>
Permission: worlds.command.backup.delete
Example
/world backup delete example:survival pre-update.zip/world backup restore
Restores a world from a backup.
Usage:
/world backup restore <world> <backup> [--confirm]
/world backup restore <world> latest [--confirm]Permission: worlds.command.backup.restore
latest restores the newest backup for that world.
Restoring is destructive, so the command requires --confirm.
Examples
/world backup restore example:survival latest --confirm
/world backup restore example:survival pre-update.zip --confirmRestoring a backup replaces the current world data. Create a backup first if you need to keep the current state.
/world backup prune
Deletes backups older than the provided duration.
Usage: /world backup prune <age>
Permission: worlds.command.backup.prune
Example
/world backup prune 30dBackup 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>/
Permissions
worlds.commands.backupworlds.command.backupworlds.command.backup.createworlds.command.backup.deleteworlds.command.backup.listworlds.command.backup.pruneworlds.command.backup.restore
Last updated on