Maintenances

Schedule and communicate planned downtime to your users.

Overview

Maintenances are scheduled events that may affect service availability. Unlike incidents (unplanned), maintenances are planned in advance and communicated proactively.

Maintenance Lifecycle

Automatic Transitions

ReliaPulse automatically transitions maintenances:

Scheduled → In Progress (at start time)
In Progress → Completed (at end time, if auto-complete enabled)

Creating a Maintenance

1. Navigate to Dashboard > Maintenances
2. Click "Schedule Maintenance"
3. Fill in details:

Basic Information

Affected Components

1. Select components affected by maintenance
2. Choose the status during maintenance:
   • Under Maintenance (recommended)
   • Degraded Performance
   • Partial Outage

Description

Explain:

• What work is being done
• Expected impact
• User actions needed (if any)

4. Click "Schedule"

Maintenance Updates

Add updates during maintenance:

1. Open the maintenance
2. Click "Add Update"
3. Write the update:
   • Progress information
   • Timeline changes
   • Issues encountered
4. Click "Post Update"

Managing Maintenances

Starting Early

To start maintenance before scheduled time:

1. Open the maintenance
2. Click "Start Now"
3. Confirm

Extending

If maintenance takes longer:

1. Open the maintenance
2. Click "Extend"
3. Enter new end time
4. Add an update explaining the extension

Completing Early

If maintenance finishes before scheduled end:

1. Open the maintenance
2. Click "Complete"
3. Add completion update
4. Ensure components return to operational

Cancelling

To cancel a scheduled maintenance:

1. Open the maintenance
2. Click "Cancel"
3. Provide cancellation reason
4. Subscribers will be notified

Recurring Maintenances

Set up regular maintenance windows:

curl -X POST http://localhost:3000/api/v1/maintenances \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Weekly Database Maintenance",
    "recurrence": {
      "frequency": "weekly",
      "dayOfWeek": 0,
      "startTime": "02:00",
      "duration": 60
    },
    "componentIds": ["component-id"]
  }'

Notifications

Subscribers are notified:

• When maintenance is scheduled
• When maintenance starts
• When updates are posted
• When maintenance completes or is cancelled

Advance Notice

Configure advance notifications:

• 24 hours before
• 1 hour before
• At start time

Status Page Display

Scheduled Maintenances

Shows as a banner on the status page:

🔧 Scheduled Maintenance
Database Migration
Scheduled for: Jan 25, 2026 02:00 - 04:00 UTC

In Progress

During maintenance:

• Status banner shows "Maintenance in Progress"
• Affected components show maintenance status
• Live updates appear as they're posted

After Completion

• Maintenance moves to history
• Can be viewed in "Past Maintenances"
• Components return to normal status

API Access

List Maintenances

curl http://localhost:3000/api/v1/maintenances \
  -H "Authorization: Bearer sk_live_xxx"

Create Maintenance

curl -X POST http://localhost:3000/api/v1/maintenances \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Server Upgrade",
    "description": "Upgrading servers to improve performance",
    "scheduledStartAt": "2026-01-25T02:00:00Z",
    "scheduledEndAt": "2026-01-25T04:00:00Z",
    "componentIds": ["comp-1", "comp-2"],
    "autoStart": true,
    "autoComplete": true
  }'

Update Maintenance

curl -X PATCH http://localhost:3000/api/v1/maintenances/{id} \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "in_progress"
  }'

Add Update

curl -X POST http://localhost:3000/api/v1/maintenances/{id}/updates \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Server upgrade 50% complete"
  }'

Best Practices

Scheduling

• Schedule during low-traffic periods
• Give adequate advance notice (24-72 hours)
• Account for timezone of your users
• Buffer extra time for unexpected issues

Communication

• Be specific about expected impact
• Provide workarounds if available
• Update regularly during maintenance
• Confirm completion promptly

Testing

• Test maintenance procedures in staging
• Have rollback plan ready
• Verify monitoring is configured correctly

Documentation

• Keep maintenance logs
• Document what was done
• Note any issues for future reference

Related Documentation

• Components - Affected components
• Incidents - For unplanned issues
• Notifications - Subscriber alerts