Skip to main content

📅Schedules

Schedules are a way to run commands, or server events like backups, restarts etc on a schedule.

This can be helpful if you want to automate time consuming tasks.

Start by heading to the Schedules tab on your server

Here you can press the Create Button, this will create your first schedule

Name: The name of your scheduled task (For organisation)

Time: This selection box allows you to select presets, e.g. Every minute, week, month etc

Minutes, Hour, Day Of Month, Month, Day of week: Allows you to set specific times, do not touch this is you do not know what you are doing

Active: Is this schedule active / allowed to run?

Only When Online: Should this schedule run only when the server is online?

When you have filled out the details, click Create

Now your schedule has been created, we need to add some commands / events for it to run.

To do this click View on your schedule, then click New Task

Action: What type of action will it perform? A command, Power (turning server on, off, or restart), Backup.

Payload: Only needed if the action is Command, here is where you will enter in the command which will be executed in the console.

Continue on failure: If other tasks in the schedule failed, should it still run this task?

Time Offset: How many seconds would you like this task to be offset compared to the rest (if there are any others).

When you have finished, press Create

Error! The cron data provided does not evaluate to a valid expression

This error means that the Cron input (the scheduled time) is not in the correct format.

The correct Cron Format sheet:

Field Position Allowed Values Description Example
Minute 1 0-59 The minute of the hour to run at 0 = on the hour
Hour 2 0-23 The hour of the day to run at 14 = 2 PM
Day of month 3 1-31 The day of the month to run on 1 = first day
Month 4 1-12 The month to run in 12 = December
Day of week 5 0-6 (0 = Sunday) The day of the week to run on 1 = Monday

Special Characters

Symbol Meaning Example Result
* Every possible value * * * * * Runs every minute
, Multiple values 1,15 in minutes Runs at minute 1 and 15
- Range of values 1-5 in hours Runs at hours 1,2,3,4,5
/ Step / interval */5 in minutes Runs every 5 minutes

Common Examples

Cron Expression Meaning
0 0 * * * Every day at midnight
*/5 * * * * Every 5 minutes
30 14 * * 1 2:30 PM every Monday
0 */6 * * * Every 6 hours
0 0 1 * * Midnight on the 1st of each month
Back to top