Uptimeify Docs
Website configuration

Check Maintenance (Website)

Checks if a website is currently in an active maintenance window.

GET /api/maintenance-windows/check/:websiteId

This endpoint requires authentication via browser session or API token.

Parameters

  • websiteId (Path, required): Internal numeric website ID or websitePublicId (UUID).

Example (cURL)

BASE_URL="https://uptimeify.io"
API_TOKEN="wsm_your_real_api_token"

curl -X GET "$BASE_URL/api/maintenance-windows/check/cd11a84d-96a2-41aa-a957-b1db8ee01b72" \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Accept: application/json"

Example Response

{
  "inMaintenance": true,
  "activeWindows": [
    {
      "id": 5,
      "name": "Weekly maintenance",
      "startTime": "2026-02-25T02:00:00.000Z",
      "endTime": "2026-02-25T04:00:00.000Z",
      "description": "Planned downtime"
    }
  ]
}

Common errors

  • 401 Unauthorized when no valid session or API token is sent
  • 403 Forbidden when the website is outside the allowed customer/organization scope
  • 400 Invalid Website identifier when :websiteId is neither a positive integer ID nor a UUID
  • 404 Website not found when the provided websitePublicId does not resolve to a website

On this page