Reference

Create Backup

Zips the whole server, or only its active world, into a backup archive.

Category
Action
Topics
Scheduler ยท Backups
01

Ports

Create Backupaction
  • triggercontrol
  • onCompletecontrol
  • onFailedcontrol
  • Backup filenamestring
Ports Control Data
Data types string number bool

Strings accept any data input.
Numbers accept boolean input.

02

Fields

Field What it does Default Limits
Target Chooses between the whole server folder and the active world. Full server
  • Full server
  • Active world
03

What a run does

Zips the chosen target and adds the archive to the server's backups.
Full server zips the whole server folder.
Active world zips the level-name folder from server.properties with its _nether and _the_end folders.

On a running server it pauses world saves first and resumes them afterwards.
A stopped server is zipped as it is.
A running server's Distant Horizons databases are left out of the archive.
Those are the DistantHorizons.sqlite files and their -wal and -shm companions.

The archive is named like 04817_21_10_26_142530.zip: an id, then day, month, year and time.
It leaves by onComplete when the archive is written, and by onFailed on any error.
Backup filename carries the archive's file name after a successful run.

04

Errors

Message says Do
a backup is already running for this server Wait for the running backup or restore to finish.
could not pause world saves: reason Enable RCON or start the server from Konnekt, so a save command can reach it.
server folder not found: path Check the server's folder in its settings.
world folder "name" not found Check level-name in server.properties.