Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Maintenance

Schedule Maintenance

Schedule a new maintenance event.

post/maintenance/schedule

Headers

x-api-idstring required
x-api-keystring required

Request body

statuspage_idstring required

ID of the status page

all_infrastructure_affectedstring required

Apply to all components and containers. Set to 1 to affect all infrastructure, 0 to use specific infrastructure_affected list (default: 0).

infrastructure_affectedstring[] required
maintenance_namestring required

Descriptive title for this maintenance event

maintenance_detailsstring required

Message describing this maintenance

date_planned_startstring required

Scheduled maintenance start date in MM/dd/yyyy format

time_planned_startstring required

Scheduled maintenance start time in HH:mm format (24-hour)

date_planned_endstring required

Scheduled maintenance end date in MM/dd/yyyy format

time_planned_endstring required

Scheduled maintenance end time in HH:mm format (24-hour)

maintenance_notify_nowstring required

Notify subscribers immediately. Set to 1 to send notification, 0 to skip.

maintenance_notify_72_hrstring required

Notify subscribers 72 hours before scheduled maintenance start time. Set to 1 to send notification, 0 to skip.

maintenance_notify_24_hrstring required

Notify subscribers 24 hours before scheduled maintenance start time. Set to 1 to send notification, 0 to skip.

maintenance_notify_1_hrstring required

Notify subscribers 1 hour before scheduled maintenance start time. Set to 1 to send notification, 0 to skip.

message_subjectstring

The message subject for email notifications. How to use variables in the message subject

automationstring required

Automatically start and end the maintenance. Set to 1 to enable automation, 0 to disable (default: 0).

automation_start_textstring

Message content when maintenance starts

automation_stop_textstring

Message content when maintenance ends

automation_notify_start_emailstring

Notify email subscribers at the start of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_start_smsstring

Notify SMS subscribers at the start of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_start_webhookstring

Notify webhook subscribers at the start of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_start_twitterstring

Post to Twitter/X at the start of the maintenance. Set to 1 to send tweet, 0 to skip (default: 0).

automation_notify_start_ircstring

Notify IRC channel at the start of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_start_msteamsstring

Notify Microsoft Teams channels at the start of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_start_slackstring

Notify Slack channels at the start of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_stop_emailstring

Notify email subscribers at the end of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_stop_smsstring

Notify SMS subscribers at the end of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_stop_webhookstring

Notify webhook subscribers at the end of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_stop_twitterstring

Post to Twitter/X at the end of the maintenance. Set to 1 to send tweet, 0 to skip (default: 0).

automation_notify_stop_ircstring

Notify IRC channel at the end of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_stop_msteamsstring

Notify Microsoft Teams channels at the end of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

automation_notify_stop_slackstring

Notify Slack channels at the end of the maintenance. Set to 1 to send notification, 0 to skip (default: 0).

Example request

{
  "all_infrastructure_affected": "0",
  "automation": "0",
  "date_planned_end": "05/07/2014",
  "date_planned_start": "05/07/2014",
  "infrastructure_affected": [
    "53d746c0383cd493cf00001a-53d746c0383cd493cf00001b",
    "53d746c0383cd493cf00001a-53d746c8383cd493cf00001e"
  ],
  "maintenance_details": "We will be upgrading router firmware to version 12.0.7 to improve network performance and security. No service downtime is expected during this maintenance window.",
  "maintenance_name": "Network Infrastructure Upgrade",
  "maintenance_notify_1_hr": "0",
  "maintenance_notify_24_hr": "0",
  "maintenance_notify_72_hr": "0",
  "maintenance_notify_now": "0",
  "message_subject": "Scheduled Maintenance: Network Infrastructure Upgrade",
  "statuspage_id": "52e5e0e0893548543700000b",
  "time_planned_end": "23:30",
  "time_planned_start": "23:00"
}

Response

OK

resultstring

Example response

{
  "result": "52e5e0e3290548543700000b",
  "status": {
    "error": "no",
    "message": "OK"
  }
}