Skip to main content
Use scheduled maintenance to tell users when you plan to work on your services and how the work may affect them. A scheduled maintenance event consists of:
  • Name: A brief description of the maintenance.
  • Message: A detailed description of the maintenance.
  • Scheduled At: The date and time when the maintenance will start.
  • Completed At: The date and time when the maintenance was completed.
  • Published At: An optional time to publish the maintenance. While set in the future, the maintenance is hidden from the status page and public API until that moment. Leave it empty to publish immediately.
  • Components: The components affected by the maintenance, along with the status each should display while it’s underway (typically Under Maintenance).
  • Notify subscribers: Whether to notify your subscribers about this maintenance, for example when it’s rescheduled or completed.

​
Schedule statuses

Cachet determines a schedule’s status from the current date and time. The possible statuses are:
  • Upcoming: The maintenance is scheduled to start in the future.
  • In Progress: The maintenance is currently in progress.
  • Complete: The maintenance has been completed.

​
Scheduling publication

To prepare maintenance before publishing it, set Published At to a future date and time. The maintenance stays a draft until that time, then appears automatically. Until the published date passes:
  • The maintenance is hidden from the status page and from public reads of the API, including requests from guests and read-only API tokens.
  • It stays fully visible and editable in the dashboard, over the MCP server, and to API tokens with the schedules.manage ability.
  • Any subscriber notifications are deferred until the maintenance is published.
This is independent of Scheduled At, which controls when the maintenance window itself begins. Leave Published At empty to publish the maintenance immediately.
Subscriber notifications for published maintenance are dispatched by the scheduled cachet:publish-scheduled command, so make sure Cachet’s scheduler is running.

​
Schedule updates

Add an update when maintenance takes longer than expected or when you have more information to share. A scheduled update consists of:
  • Message: A detailed description of the update.
  • Completed At: The date and time that the maintenance was completed.
To update a schedule, open Schedules in the dashboard and click Record Update on the schedule.
You cannot add updates to “Completed” schedules.