Schedules - XyraPanel

Overview

Schedules allow you to automate repetitive tasks on your game server using cron expressions. Create scheduled backups, automated restarts, timed announcements, and complex task chains that execute in sequence.

Accessing Schedules

Navigate to your server’s schedule management:

/server/{server-identifier}/schedules

The schedules page displays all configured schedules with their status, next run time, and associated tasks.

Creating a Schedule

Click New Schedule

Click the New Schedule button in the top-right corner.

Configure Schedule

Fill in the schedule details:

Schedule Name: Descriptive name (e.g., “Daily Restart”)
Cron Expression: When to run (see Cron Timing below)
Enabled: Whether the schedule is active

Set Timing

Use the cron fields or quick presets to define when the schedule runs.

Create Schedule

Click Create to save the schedule. You can then add tasks to it.

API endpoint:

POST /api/client/servers/{server}/schedules

Request Body Example

{
  "name": "Daily Restart",
  "cron": {
    "minute": "0",
    "hour": "4",
    "day_of_month": "*",
    "month": "*",
    "day_of_week": "*"
  },
  "is_active": true
}

Cron Timing

Schedules use standard cron syntax with 5 fields:

Minute Hour DayOfMonth Month DayOfWeek

Cron Fields

Minute
Hour
Day of Month
Month
Day of Week

0-59: Minute of the hourExamples:

0 = Top of the hour
30 = Half past the hour
*/5 = Every 5 minutes
* = Every minute

0-23: Hour of the day (24-hour format)Examples:

0 = Midnight
12 = Noon
*/2 = Every 2 hours
* = Every hour

1-31: Day of the monthExamples:

1 = First day of month
15 = 15th of month
*/7 = Every 7 days
* = Every day

1-12: Month of the yearExamples:

1 = January
6 = June
*/3 = Every 3 months
* = Every month

0-6: Day of the week (0 = Sunday)Examples:

0 = Sunday
1 = Monday
5 = Friday
* = Every day

Quick Presets

Use the preset buttons for common schedules:

Every Minute

* * * * *

Every 5 Minutes

*/5 * * * *

Every Hour

0 * * * *

Daily at Midnight

0 0 * * *

Weekly on Sunday

0 0 * * 0

Example Cron Expressions

Common Schedules

0 4 * * * = Daily at 4:00 AM
0 */6 * * * = Every 6 hours
30 2 * * 0 = Every Sunday at 2:30 AM
0 0 1 * * = First day of every month at midnight
*/30 * * * * = Every 30 minutes
0 6 * * 1-5 = Weekdays at 6:00 AM

Schedule Tasks

Each schedule can have multiple tasks that execute in sequence. Tasks run in order based on their sequence ID with optional time offsets.

Task Types

Schedules support three types of tasks:

Command
Power
Backup

Execute a console command:

Action: command
Payload: The command to run (e.g., say Server restarting in 5 minutes)
Example use: Announcements, world saves, custom commands

Control server power state:

Action: power
Payload: One of start, stop, restart, kill
Example use: Automated restarts, scheduled shutdowns

Create a server backup:

Action: backup
Payload: Backup name (optional)
Example use: Scheduled backups before maintenance

Adding Tasks

Open Task Manager

Click Manage Tasks on a schedule to open the task management modal.

Choose Action Type

Select Command, Power, or Backup from the action buttons.

Configure Task

Fill in the task details:

Payload: Command text, power action, or backup name
Time Offset: Seconds to wait before executing (0-3600)
Continue on Failure: Whether to continue if this task fails

Add Task

Click Add Task to add it to the schedule.

API endpoint:

POST /api/client/servers/{server}/schedules/{schedule}/tasks

Request Body Examples

Command Task

{
  "action": "command",
  "payload": "say Server will restart in 5 minutes!",
  "time_offset": 0,
  "continue_on_failure": false
}

Power Task

{
  "action": "power",
  "payload": "restart",
  "time_offset": 300,
  "continue_on_failure": true
}

Backup Task

{
  "action": "backup",
  "payload": "scheduled-backup",
  "time_offset": 0,
  "continue_on_failure": false
}

Task Execution Order

Tasks execute sequentially in order of their Sequence ID:

Sequence ID #1 executes at schedule trigger time
Wait for Task #1’s time offset
Execute Task #1
If continue_on_failure is false and task fails, stop here
Wait for Task #2’s time offset
Execute Task #2
Continue until all tasks complete

Time Offsets

Time offsets delay task execution:

0 seconds: Execute immediately
60 seconds: Wait 1 minute before executing
300 seconds: Wait 5 minutes
3600 seconds: Wait 1 hour (maximum)

Example sequence:

Task #1: Command "say Restart in 5 minutes" | Offset: 0s
Task #2: Command "say Restart in 1 minute" | Offset: 240s
Task #3: Power "restart" | Offset: 60s

This announces 5 minutes before restart, then 1 minute before, then restarts.

Example Schedules

Daily Restart with Warnings

Create Schedule

Name: Daily Restart
Cron: 0 4 * * * (4 AM daily)

Add Tasks

Command: say Server restarting in 5 minutes for maintenance (offset: 0s)
Command: say Server restarting in 1 minute! Save your progress! (offset: 240s)
Power: restart (offset: 60s)

Hourly Backups

Create Schedule

Name: Hourly Backup
Cron: 0 * * * * (Every hour)

Add Task

Backup: hourly-backup-{timestamp} (offset: 0s)

Weekly Maintenance

Create Schedule

Name: Weekly Maintenance
Cron: 0 3 * * 0 (Sundays at 3 AM)

Add Tasks

Command: save-all (offset: 0s)
Backup: weekly-maintenance (offset: 30s)
Command: say Server will be down for 10 minutes for maintenance (offset: 30s)
Power: stop (offset: 60s)
Power: start (offset: 600s) — continues on failure

Managing Schedules

Edit Schedule

Click the Edit button on a schedule
Modify the name, cron expression, or enabled status
Click Save

API: POST /api/client/servers/{server}/schedules/{schedule}

Force Run

Manually trigger a schedule:

Click the Force Run button
All tasks execute immediately regardless of cron timing
Useful for testing schedules

API: POST /api/client/servers/{server}/schedules/{schedule}/run

Delete Schedule

Deleting a schedule permanently removes it and all associated tasks. This cannot be undone.

Click the Delete button
Confirm deletion in the modal
Schedule and all tasks are removed

API: DELETE /api/client/servers/{server}/schedules/{schedule}

Schedule Status

Schedules display their current status:

Enabled

Schedule is active and will run at the next scheduled time.

Paused

Schedule is disabled and will not run until re-enabled.

Schedule Information

Each schedule shows:

Cron Expression: The timing pattern
Task Count: Number of configured tasks
Next Run: When the schedule will next execute
Last Run: When the schedule last executed

Task Management

Editing Tasks

Tasks cannot be edited directly. To modify a task:

Delete the existing task
Create a new task with updated settings

Deleting Tasks

Open Manage Tasks for the schedule
Click the trash icon next to a task
Confirm deletion
Task is removed from the sequence

API: DELETE /api/client/servers/{server}/schedules/{schedule}/tasks/{task}

Reordering Tasks

Tasks execute in sequence order (Sequence ID). To reorder:

Delete tasks you want to reorder
Re-create them in the desired order
Tasks are automatically assigned sequential IDs

Permissions

Schedule management requires:

View schedules: server.schedule.read
Create schedules: server.schedule.create
Edit schedules: server.schedule.update
Delete schedules: server.schedule.delete
Manage tasks: server.schedule.update

Server owners and admins have all permissions by default.

Best Practices

Test First

Use Force Run to test schedules before relying on them for important tasks.

Add Warnings

For restart schedules, announce ahead of time so players can prepare.

Use Continue on Failure

Enable for power actions so later tasks still execute if one fails.

Stagger Backups

Don’t schedule all servers’ backups at the same time to avoid performance issues.

Troubleshooting

Schedule not running

Check that the schedule is Enabled (not paused)
Verify the cron expression is correct
Ensure the schedule has at least one task
Check server logs for execution errors

Tasks executing in wrong order

Tasks run by sequence ID, which is assigned in creation order
Delete and recreate tasks in the correct order if needed

Command task not working

Verify the command syntax is correct for your game
Check server console for command output/errors
Ensure the server is running when the command executes

API Reference

List Schedules

GET /api/client/servers/{server}/schedules

Response Example

{
  "data": [
    {
      "id": "schedule-uuid",
      "name": "Daily Restart",
      "cron": "0 4 * * *",
      "is_active": true,
      "is_processing": false,
      "only_when_online": false,
      "last_run_at": "2024-01-15T04:00:00Z",
      "next_run_at": "2024-01-16T04:00:00Z",
      "created_at": "2024-01-10T12:00:00Z",
      "updated_at": "2024-01-10T12:00:00Z",
      "tasks": [
        {
          "id": "task-uuid",
          "sequence_id": 1,
          "action": "command",
          "payload": "say Restarting soon",
          "time_offset": 0,
          "continue_on_failure": false,
          "is_queued": false
        }
      ]
    }
  ]
}

Overview

Getting Started

Server Management

Administration

Configuration

CLI

Advanced

​Overview

​Accessing Schedules

​Creating a Schedule

​Cron Timing

​Cron Fields

​Quick Presets

Every Minute

Every 5 Minutes

Every Hour

Daily at Midnight

Weekly on Sunday

​Example Cron Expressions

​Schedule Tasks

​Task Types

​Adding Tasks

​Task Execution Order

​Time Offsets

​Example Schedules

​Daily Restart with Warnings

​Hourly Backups

​Weekly Maintenance

​Managing Schedules

​Edit Schedule

​Force Run

​Delete Schedule

​Schedule Status

Enabled

Paused

​Schedule Information

​Task Management

​Editing Tasks

​Deleting Tasks

​Reordering Tasks

​Permissions

​Best Practices

Test First

Add Warnings

Use Continue on Failure

Stagger Backups

​Troubleshooting

​API Reference

​List Schedules

​Next Steps

Backups

Server Console

Build docs developers (and LLMs) love

Overview

Accessing Schedules

Creating a Schedule

Cron Timing

Cron Fields

Quick Presets

Example Cron Expressions

Schedule Tasks

Task Types

Adding Tasks

Task Execution Order

Time Offsets

Example Schedules

Daily Restart with Warnings

Hourly Backups

Weekly Maintenance

Managing Schedules

Edit Schedule

Force Run

Delete Schedule

Schedule Status

Schedule Information

Task Management

Editing Tasks

Deleting Tasks

Reordering Tasks

Permissions

Best Practices

Troubleshooting

API Reference

List Schedules

Next Steps