Skip to content

Agent job kinds ​

Every job the panel can send to a node. The agent leases jobs one at a time per server; see the agent protocol. Unknown kinds are failed with an error.

KindWhat it does
agent.updateDownload the new agent, verify its SHA-256, trial-run it, keep the old binary as .prev, swap and re-execute.
backupArchive the server's data (from a frozen snapshot when the node uses volumes) and upload it with the signed URL.
commandSend one console command: RCON for Minecraft (queued on the console pipe while the server is starting), stdin for other games.
configureApply new limits to a running container, or (with recreate) remove and recreate it with new settings, ports or environment. Also resizes the data volume.
createCreate the data volume and the container for a server and start it.
deleteRemove the container, its data volume and its files.
evictRemove this node's copy of a server that now lives elsewhere (failover); data is moved aside and kept for the configured retention.
file.deleteDelete regular files (never folders, never through symlinks).
file.downloadStream a file for download.
file.exportSend a file or folder from the server's data directory to the panel for download.
file.extractExtract an archive inside the data directory with traversal protection.
file.fetchDownload one file for an add-on: HTTPS only, hosts listed in the job, public addresses only, SHA-512 (or SHA-256) must match, size counted against the disk allowance, placed atomically. An optional replace list removes old files only after the new one is in place.
file.importReceive an uploaded file from the panel into the server's data directory.
file.listList a folder in the server's data directory.
file.mkdirCreate a folder.
file.readRead a text file for the editor.
file.renameRename a file; used for add-ons only to add or drop the .disabled suffix, never overwriting.
file.uploadWrite an uploaded file.
file.writeWrite a text file from the editor.
killKill the container immediately.
logsReturn the last lines of the container log.
reinstallDelete the server's data and container and create them again.
restartStop gracefully and start again.
restoreDownload a backup and replace the server's files with it, staging before the swap. Can restore a backup of another server (clone, failover).
startStart the container (re-mounting the data volume first when needed).
stopStop gracefully: RCON or the console pipe for Minecraft, otherwise docker stop.
verify-backupDownload a backup archive and check its integrity and safe extraction.

Released under the AGPL-3.0-only license.