PUT/v1/maintenance-windows/{maintenance_uuid}

Update a maintenance window

Updates an existing maintenance window.

Request

Path Parameters

uuidstringrequired

The unique identifier of the maintenance window to update

Example:"mw_ot0dguXcrUnB2b"

Bodyapplication/json

namestringrequired

The maintenance window name for internal use

start_datestringrequired

The start date of the maintenance window in ISO 8601 format

end_datestringrequired

The end date of the maintenance window in ISO 8601 format

monitorsarray<string>required

Array of monitor and component UUIDs affected by this maintenance

statuspagesarray<string>optional

Array of status page UUIDs where the maintenance will be displayed

titleobjectoptional

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

updatesarray<object>optional

Array of update messages. Each update has a text object (localized) and a date in ISO 8601 format.

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

Response

Returns a success message on successful update.

RequestcURL

curl -X PUT https://api.hyperping.io/v1/maintenance-windows/mw_ot0dguXcrUnB2b \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Database Infrastructure Upgrade",
    "start_date": "2025-05-19T14:30:00Z",
    "end_date": "2025-05-19T15:30:00Z",
    "monitors": ["mon_CR50CWuwAcj1uL", "mon_Xw7pJsR2Lm3nT"],
    "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
  }'

200 OKJSON

{
  "message": "Ok"
}

← Create a maintenance window Delete a maintenance window →