Schedule server jobs
Create an agent-side scheduled job, test it, and choose retry and catch-up behavior.
Automations run on the agent. They can execute a shell command, send an HTTP request, or send a game-console command. They are not a cloud scheduler that runs jobs while the agent is stopped.
Before you begin
You need access to the server and permission to manage its automations. Shell and game-console actions require the corresponding agent capabilities. Test on a non-production server first.
Create a harmless scheduled command
For a Paper server:
- Open Automations and choose New. The New automation dialog opens.
- Set Name to
Player list check. - Set Action to In-game command and enter
list. - Set Cron expression to
0 * * * *and Timezone toUTC. - Keep Retry policy at Never retry. Set Offline catch-up to Skip missed jobs while offline. New automations replay missed jobs by default.
- Choose Create automation.
- Select the automation row to expand it, choose Run now, and inspect its run history and console output.
Expect a successful run and Paper's player-list response. Disable or delete this trial job when you no longer need it.
Choose a schedule
Use five-field cron syntax, with no seconds field. The Schedule column describes each schedule in words. Hover over it to see the cron expression.
| Expression | Schedule in the chosen timezone |
|---|---|
*/15 * * * * | Every 15 minutes |
0 * * * * | At the start of each hour |
0 4 * * * | Daily at 04:00 |
0 3 * * 1 | Mondays at 03:00 |
The default timezone is UTC. Use an IANA timezone such as Europe/Berlin when the job follows local time. Consider daylight-saving transitions when scheduling maintenance.
Choose retries and catch-up deliberately
Set Retry policy to one of these values:
- Never retry: one failed attempt remains failed. This is the default.
- Fixed delay: repeats after the configured delay, up to Max retries.
- Exponential backoff: increases the delay each time, with an optional maximum.
Set Offline catch-up to one of these values:
- Replay missed jobs on startup: runs up to Max startup runs missed jobs when the agent starts. This is the default, with a limit of three.
- Skip missed jobs while offline: does not replay schedules missed while the agent was offline. Repeating a request can cause duplicate changes. Enable retries or catch-up only for an action that can safely run again.
Shell and web-request jobs
Shell jobs run as the agent user. Set the working directory explicitly for scripts. Run through a shell is off by default. Turn it on only when the command needs shell syntax, such as pipes or redirects.
Web requests originate from the agent environment. Set the method, headers, body, and timeout. The default timeout is 30 seconds, with a supported range of 1 to 300 seconds. Keep credentials out of shared job descriptions and screenshots.
Inspect failures
Read the run's status, reason, attempt, scheduled time, and failure. Confirm the agent had the required CLI, network access, and filesystem permissions.
For backups, use a tested backup script. A successful job exit does not prove that the backup can be restored.
Was this page helpful?
Send a quick note if anything is missing or unclear.
Last updated on