---
title: "Schedule Maintenance"
method: POST
path: "/maintenance/schedule"
tags: ["Maintenance"]
---

# Schedule Maintenance

`POST /maintenance/schedule`

Schedule a new maintenance event.

## Headers

- `x-api-id` string, required
- `x-api-key` string, required

## Request body

- object
  - `statuspage_id` string, required — ID of the status page
  - `all_infrastructure_affected` string, required — Apply to all components and containers. Set to `1` to affect all infrastructure, `0` to use specific infrastructure_affected list (default: `0`).
  - `infrastructure_affected` string[], required
  - `maintenance_name` string, required — Descriptive title for this maintenance event
  - `maintenance_details` string, required — Message describing this maintenance
  - `date_planned_start` string, required — Scheduled maintenance start date in MM/dd/yyyy format
  - `time_planned_start` string, required — Scheduled maintenance start time in HH:mm format (24-hour)
  - `date_planned_end` string, required — Scheduled maintenance end date in MM/dd/yyyy format
  - `time_planned_end` string, required — Scheduled maintenance end time in HH:mm format (24-hour)
  - `maintenance_notify_now` string, required — Notify subscribers immediately. Set to `1` to send notification, `0` to skip.
  - `maintenance_notify_72_hr` string, required — Notify subscribers 72 hours before scheduled maintenance start time. Set to `1` to send notification, `0` to skip.
  - `maintenance_notify_24_hr` string, required — Notify subscribers 24 hours before scheduled maintenance start time. Set to `1` to send notification, `0` to skip.
  - `maintenance_notify_1_hr` string, required — Notify subscribers 1 hour before scheduled maintenance start time. Set to `1` to send notification, `0` to skip.
  - `message_subject` string — The message subject for email notifications. [How to use variables in the message subject](http://kb.status.io/notifications/message-subject-variables/)
  - `automation` string, required — Automatically start and end the maintenance. Set to `1` to enable automation, `0` to disable (default: `0`).
  - `automation_start_text` string — Message content when maintenance starts
  - `automation_stop_text` string — Message content when maintenance ends
  - `automation_notify_start_email` string — Notify email subscribers at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_start_sms` string — Notify SMS subscribers at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_start_webhook` string — Notify webhook subscribers at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_start_twitter` string — Post to Twitter/X at the start of the maintenance. Set to `1` to send tweet, `0` to skip (default: `0`).
  - `automation_notify_start_irc` string — Notify IRC channel at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_start_msteams` string — Notify Microsoft Teams channels at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_start_slack` string — Notify Slack channels at the start of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_stop_email` string — Notify email subscribers at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_stop_sms` string — Notify SMS subscribers at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_stop_webhook` string — Notify webhook subscribers at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_stop_twitter` string — Post to Twitter/X at the end of the maintenance. Set to `1` to send tweet, `0` to skip (default: `0`).
  - `automation_notify_stop_irc` string — Notify IRC channel at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_stop_msteams` string — Notify Microsoft Teams channels at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).
  - `automation_notify_stop_slack` string — Notify Slack channels at the end of the maintenance. Set to `1` to send notification, `0` to skip (default: `0`).

## Response `200`

OK

- object
  - `result` string
  - `status` object
    - `error` string
    - `message` string

---

[API](https://skmtc.net/status/apis/status-io-api-v2.md) · [All operations](https://skmtc.net/status/apis/status-io-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/status/status-io-api-v2/versions/6054bf6d1a84/schema)