Sign in

v1

latestOpenAPI 3.1.02026-08-06360288.3 KB
Maintenance

Start Maintenance

Start a scheduled maintenance event immediately. This moves the maintenance from pending to active status.

post/maintenance/start

Headers

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

Request body

statuspage_idstring required

ID of the status page

maintenance_idstring required

ID of the maintenance event

maintenance_detailsstring required

Message describing this maintenance update

socialstring required

Automatically post this update to Twitter/X. Set to 1 to post a message, 0 to skip.

notify_emailstring

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

notify_smsstring

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

notify_webhookstring

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

ircstring

Notify IRC channel. Set to 1 to send notification, 0 to skip.

msteamsstring

Notify Microsoft Teams channels. Set to 1 to send notification, 0 to skip.

slackstring

Notify Slack channels. 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

Example request

{
  "irc": "0",
  "maintenance_details": "Scheduled maintenance has begun. We are performing the planned infrastructure upgrades. Service may experience brief interruptions during this time.",
  "maintenance_id": "52e5eacc908cdc5e39000009",
  "message_subject": "Maintenance Started: Network Infrastructure Upgrade",
  "msteams": "0",
  "notify_email": "0",
  "notify_sms": "1",
  "notify_webhook": "0",
  "slack": "0",
  "social": "0",
  "statuspage_id": "52e5e0e0893548543700000b"
}

Response

OK

resultboolean

Example response

{
  "result": true,
  "status": {
    "error": "no",
    "message": "OK"
  }
}