POST/v1/maintenance-windows

Create a maintenance window

Creates a new maintenance window.

Request

Bodyapplication/json

namestringrequired

The maintenance window name for internal use

Example:"Scheduled Database Maintenance"

start_datestringrequired

The start date of the maintenance window in ISO 8601 format

Example:"2025-05-18T14:30:00Z"

end_datestringrequired

The end date of the maintenance window in ISO 8601 format

Example:"2025-05-18T15:30:00Z"

monitorsarray<string>required

Array of monitor and component UUIDs affected by this maintenance

Example:["mon_CR50CWuwAcj1uL", "comp_nPAIYFhHEC2szu"]

statuspagesarray<string>optional

Array of status page UUIDs where the maintenance will be displayed

Example:["sp_jsQqcFiwoK7ZjM"]

titleobjectoptional

Localized title shown on the status page. Use language keys (en, fr, de, ru, nl, pl, se). Supports basic HTML: ,  , <a>, , , , 

updatesarray<object>optional

Array of update messages. Each update has a text object (localized) and a date in ISO 8601 format. HTML formatting is supported in text values.

notificationOptionenum<string>optional

Defines how subscribers are notified about the maintenance

Available options:

noneimmediatescheduled

Default: none

notificationMinutesnumberoptional

Minutes before the start to send notification. Only used when notificationOption is scheduled.

Default: 60

💡Notification Options

none: No notifications sent. Maintenance is internal only.
immediate: Subscribers notified immediately when created.
scheduled: Subscribers notified before start (uses notificationMinutes).

Response

Returns the UUID of the newly created maintenance window.

RequestcURL

curl -X POST https://api.hyperping.io/v1/maintenance-windows \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Scheduled Database Maintenance",
    "start_date": "2025-05-18T14:30:00Z",
    "end_date": "2025-05-18T15:30:00Z",
    "monitors": ["mon_CR50CWuwAcj1uL", "comp_nPAIYFhHEC2szu"],
    "statuspages": ["sp_jsQqcFiwoK7ZjM"],
    "title": {
      "en": "Scheduled Database Upgrade",
      "fr": "Mise à niveau de la base de données planifiée"
    },
    "updates": [
      {
        "text": {
          "en": "<p>Maintenance has begun.</p>",
          "fr": "<p>La maintenance a commencé.</p>"
        },
        "date": "2025-05-18T14:35:00Z"
      }
    ],
    "notificationOption": "scheduled",
    "notificationMinutes": 60
  }'

201 CreatedJSON

{
  "uuid": "mw_ot0dguXcrUnB2b"
}

← Get a maintenance window Update a maintenance window →