⌘K
OverviewAuthenticationMaintenance APIGET List maintenanceGET Get maintenancePOST Create maintenancePUT Update maintenanceDEL Delete maintenance
GET/v1/maintenance-windows/{maintenance_uuid}

Get a maintenance window

Returns details for a specific maintenance window.

Request

Path Parameters
uuidstringrequired
The unique identifier of the maintenance window
Example:"mw_TY2vFNUbdzdskD"

Response

Returns the maintenance window object if a valid identifier was provided.

Maintenance Window Objectapplication/json
uuidstring
Unique identifier for the maintenance window
namestring
Internal name for the maintenance window
titleobject
Localized title object with language keys
start_datestring
Start date in ISO 8601 format
end_datestring
End date in ISO 8601 format
monitorsarray<string>
Array of monitor and component UUIDs
statuspagesarray<string>
Array of status page UUIDs
updatesarray<object>
Array of update messages with text and date
notificationOptionenum<string>
How subscribers are notified
Possible values:
noneimmediatescheduled
notificationMinutesnumber
Minutes before start to send scheduled notification
statusenum<string>
Current status of the maintenance window
Possible values:
upcomingongoingcompleted
createdBystring
Email of the user who created the maintenance window
createdAtstring
Creation timestamp in ISO 8601 format
RequestcURL
curl https://api.hyperping.io/v1/maintenance-windows/mw_TY2vFNUbdzdskD \
  -H "Authorization: Bearer ${API_TOKEN}"
200 OKJSON
{
  "uuid": "mw_TY2vFNUbdzdskD",
  "name": "Scheduled API Infrastructure Upgrade",
  "title": {
    "en": "Planned API Gateway Maintenance"
  },
  "start_date": "2025-12-17T14:30:00.000Z",
  "end_date": "2025-12-17T18:30:00.000Z",
  "timezone": "UTC",
  "monitors": [
    "mon_XeYIdBFK0prmGn"
  ],
  "statuspages": [
    "sp_jsQqcFiwoK7ZjM"
  ],
  "bulkUuid": null,
  "createdBy": "admin@example.com",
  "createdAt": "2025-04-17T11:49:51.000Z",
  "updates": [
    {
      "date": "2025-11-17T15:55:48.000Z",
      "text": {
        "en": "Maintenance is progressing as planned."
      }
    },
    {
      "date": "2025-11-17T15:50:48.000Z",
      "text": {
        "en": "Our engineering team has begun the scheduled maintenance."
      }
    }
  ],
  "notificationOption": "scheduled",
  "notificationMinutes": 60,
  "scheduledNotificationStatus": "pending",
  "scheduledNotificationSentAt": null,
  "scheduledNotificationBreakdown": null,
  "status": "upcoming"
}
← List maintenance windowsCreate a maintenance window →