Uptimeify Docs
Maintenance windows

Get Maintenance Window

Returns a single maintenance window by ID, including its full target and tag selection.

GET /api/maintenance-windows/{id}

Path Parameters

  • id (required): The numeric ID of the maintenance window.

Example (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X GET "$BASE_URL/api/maintenance-windows/42" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Response

{
  "id": 42,
  "publicId": "aaaaaaaa-aaaa-4aaa-8aaa-aaaaaaaaaaaa",
  "organizationId": 10,
  "customerId": 1,
  "name": "Weekly deployment",
  "description": "Rolling update every Monday",
  "startTime": "2026-07-07T02:00:00.000Z",
  "endTime": "2026-07-07T04:00:00.000Z",
  "isRecurring": true,
  "recurrencePattern": {
    "frequency": "weekly",
    "interval": 1,
    "daysOfWeek": [1]
  },
  "isActive": true,
  "targets": [
    { "type": "website", "id": 101 },
    { "type": "icmp", "id": 5 }
  ],
  "tags": [
    { "id": 7, "name": "Production", "color": "red" }
  ],
  "websiteId": null,
  "icmpMonitorId": null,
  "smtpMonitorId": null,
  "sshMonitorId": null,
  "ftpMonitorId": null,
  "imapPopMonitorId": null,
  "dnsMonitorId": null,
  "customerIpId": null,
  "customerDomainId": null,
  "createdAt": "2026-06-01T09:00:00.000Z",
  "updatedAt": "2026-06-01T09:00:00.000Z"
}

The targets array lists all explicitly selected monitors. The tags array lists the tags whose monitors are dynamically covered. Both may be non-empty simultaneously when the window uses a mixed multi-monitor + tag selection.

Common errors

  • 401 Unauthorized when you are not logged in
  • 403 Forbidden when you cannot access the organization or the window belongs to an out-of-scope customer
  • 404 Not Found when no maintenance window with the given ID exists

On this page