Schedules endpoints (Client API: game servers)

GET/api/user/servers/{uuidShort}/schedules

Get server schedules Retrieve all schedules for a specific server that the user owns or has subuser access to.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Server schedules retrieved successfully · 400 Bad request - Missing or invalid UUID short · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to retrieve schedules

POST/api/user/servers/{uuidShort}/schedules

Create schedule Create a new schedule for a server with cron expression validation and next run time calculation.

Request body: ScheduleCreateRequest (application/json) · Response data: ScheduleCreateResponse

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"","cron_day_of_week":"","cron_month":"","cron_day_of_month":"","cron_hour":"","cron_minute":"","timezone":"","is_active":false,"only_when_online":false}'

Plugin events: featherpanel:user:server:schedule:created

Responses: 201 Schedule created successfully · 400 Bad request - Missing required fields, invalid cron expression, or invalid request body · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to create schedule

GET/api/user/servers/{uuidShort}/schedules/{scheduleId}

Get specific schedule Retrieve details of a specific schedule for a server that the user owns or has subuser access to.

Response data: ServerSchedule

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Schedule details retrieved successfully · 400 Bad request - Missing or invalid parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or schedule not found · 500 Internal server error - Failed to retrieve schedule

PUT/api/user/servers/{uuidShort}/schedules/{scheduleId}

Update schedule Update an existing schedule with new cron expression validation and next run time recalculation.

Request body: ScheduleUpdateRequest (application/json)

curl -X PUT "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"","cron_day_of_week":"","cron_month":"","cron_day_of_month":"","cron_hour":"","cron_minute":"","timezone":"","is_active":false,"only_when_online":false}'

Plugin events: featherpanel:user:server:schedule:updated

Responses: 200 Schedule updated successfully · 400 Bad request - Invalid cron expression or invalid request body · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or schedule not found · 500 Internal server error - Failed to update schedule

DELETE/api/user/servers/{uuidShort}/schedules/{scheduleId}

Delete schedule Delete a schedule. Schedules that are currently processing can also be deleted (e.g. to clear stuck schedules).

curl -X DELETE "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/$SCHEDULE_ID" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:server:schedule:deleted

Responses: 200 Schedule deleted successfully · 400 Bad request - Missing parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or schedule not found · 500 Internal server error - Failed to delete schedule

POST/api/user/servers/{uuidShort}/schedules/{scheduleId}/toggle

Toggle schedule status Toggle the active status of a schedule (enable/disable).

Response data: ScheduleToggleResponse

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/$SCHEDULE_ID/toggle" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:server:schedule:status:toggle

Responses: 200 Schedule status toggled successfully · 400 Bad request - Missing or invalid parameters · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or schedule not found · 500 Internal server error - Failed to toggle schedule status

GET/api/user/servers/{uuidShort}/schedules/active

Get active schedules Retrieve all active schedules for a specific server.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/active" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Active schedules retrieved successfully · 400 Bad request - Missing or invalid UUID short · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to retrieve active schedules

GET/api/user/servers/{uuidShort}/schedules/due

Get due schedules Retrieve schedules that are due to run for a specific server.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/due" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Due schedules retrieved successfully · 400 Bad request - Missing or invalid UUID short · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to retrieve due schedules

POST/api/user/servers/{uuidShort}/schedules/{scheduleId}/run

Run schedule now Trigger a schedule to run on the next cron tick by setting its next run time to the past. The schedule must not already be processing.

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/$SCHEDULE_ID/run" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Plugin events: featherpanel:user:server:schedule:updated

Responses: 200 Schedule queued to run on next cron tick · 400 Bad request - Schedule is already processing or has no tasks · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or schedule not found · 500 Internal server error - Failed to queue schedule

GET/api/user/servers/{uuidShort}/schedules/{scheduleId}/export

Export schedule Export a schedule and all its tasks as a JSON payload that can be imported into another server.

curl -X GET "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/$SCHEDULE_ID/export" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json"

Responses: 200 Schedule exported successfully · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server or schedule not found

POST/api/user/servers/{uuidShort}/schedules/import

Import schedule Import a schedule and its tasks from a previously exported JSON payload.

curl -X POST "$PANEL_URL/api/user/servers/$UUID_SHORT/schedules/import" \
  -H "Authorization: Bearer $FEATHERPANEL_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"","cron_minute":"","cron_hour":"","cron_day_of_month":"","cron_month":"","cron_day_of_week":"","is_active":false,"only_when_online":false,"tasks":[]}'

Plugin events: featherpanel:user:server:schedule:created

Responses: 201 Schedule imported successfully · 400 Bad request - Missing required fields, invalid cron expression, or invalid task data · 401 Unauthorized - User not authenticated · 403 Forbidden - Access denied to server · 404 Not found - Server not found · 500 Internal server error - Failed to import schedule