- 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 automatically infers the status of a schedule based on 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
You can prepare maintenance well in advance without revealing it straight away. By setting a Published At date in the future, the maintenance stays a draft and appears automatically once that time arrives. Until the published date passes:- The maintenance is hidden from the status page and from public reads of the API — for guests and read-only API tokens alike.
- It stays fully visible and editable in the dashboard, over the MCP server, and to API tokens with the
schedules.manageability. - Any subscriber notifications are deferred until the maintenance is published.
Subscriber notifications for published maintenance are dispatched by the scheduled
cachet:publish-scheduled
command, so make sure Cachet’s scheduler is running.Schedule updates
You may need to provide an update on scheduled maintenance, for example if the maintenance is taking longer than expected, or you need to provide more information. A scheduled update consists of:- Message: A detailed description of the update.
- Completed At: The date and time that the maintenance was completed.
You cannot add updates to “Completed” schedules.