---
title: "List Maintenance Windows"
method: GET
path: "/api/maintenance-windows"
tags: ["Maintenance Windows"]
---

# List Maintenance Windows

`GET /api/maintenance-windows`

## Request

- Base URL: `https://uptimeify.io`
- URL: `https://uptimeify.io/api/maintenance-windows`
- Auth: HTTP bearer

GET /api/maintenance-windows

## Query parameters

- `websiteId` string
- `icmpMonitorId` string
- `smtpMonitorId` string
- `sshMonitorId` string
- `tcpMonitorId` string
- `ftpMonitorId` string
- `imapPopMonitorId` string
- `dnsMonitorId` string
- `customerIpId` string
- `customerDomainId` string
- `customerId` string
- `organizationId` string
- `activeOnly` 'true' | 'false'
- `format` 'json' | 'csv'
- `download` '0' | '1'

## Response `200`

OK

- object[]: Newest first.
  - `id` integer, required
  - `publicId` string, uuid, required
  - `websiteId` integer, nullable, required: Legacy single website target.
  - `customerIpId` integer, nullable, required: Legacy single customer IP target.
  - `customerId` integer, nullable, required: null for organization-wide tag windows.
  - `organizationId` integer, nullable, required: Set only for organization-wide tag windows.
  - `name` string, required
  - `description` string, nullable, required
  - `startTime` string, date-time, required
  - `endTime` string, date-time, required
  - `isRecurring` boolean, required
  - `recurrencePattern` object, nullable, required
    - `frequency` 'daily' | 'weekly' | 'monthly', required
    - `interval` integer
    - `daysOfWeek` integer[]
    - `dayOfMonth` integer
    - `endRecurrenceDate` string
  - `isActive` boolean, required
  - `timezone` string, required: IANA zone the recurrence is read in.
  - `createdBy` string, nullable, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `icmpMonitorId` integer, nullable, required
  - `smtpMonitorId` integer, nullable, required
  - `sshMonitorId` integer, nullable, required
  - `tcpMonitorId` integer, nullable, required
  - `ftpMonitorId` integer, nullable, required
  - `imapPopMonitorId` integer, nullable, required
  - `dnsMonitorId` integer, nullable, required
  - `customerDomainId` integer, nullable, required
  - `targetKind` 'website' | 'customerIp' | 'icmpMonitor' | 'smtpMonitor' | 'sshMonitor' | 'tcpMonitor' | 'ftpMonitor' | 'imapPopMonitor' | 'dnsMonitor' | 'customerDomain' | 'customer', required: customer for windows with several targets, tags, or the whole customer.
  - `targetName` string, nullable, required
  - `customerName` string, nullable, required
  - `website` object, nullable, required: Deprecated: use websiteSummary.
  - `websiteSummary` object, nullable, required: The legacy target website (websiteId), or null.
    - `id` integer, required
    - `publicId` string, uuid, required
    - `name` string, required
    - `url` string, required
  - `customerIp` object, nullable, required
    - `id` integer, required
    - `label` string, nullable, required
    - `ipAddress` string, required
    - `publicId` string, uuid, required
    - `customerId` integer, required
  - `customerPublicId` string, uuid, nullable, required
  - `targets` object[], required
    - `type` 'website' | 'dns' | 'icmp' | 'smtp' | 'ssh' | 'tcp' | 'ftp' | 'imap_pop' | 'customer_domain' | 'customer_ip', required
    - `id` integer, required
    - `name` string
    - `publicId` string
  - `tags` object[], required
    - `id` integer, required
    - `publicId` string, uuid, required
    - `name` string, required
    - `color` string, nullable, required

## Other responses

- `400`: Invalid or missing parameters.
- `401`: Missing, invalid or expired API token.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api.md) · [All operations](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/uptimeify/apis/uptimeify-rest-api/revisions/2129a771ee7e?raw)