Maintenance Windows

List Maintenance Windows

GET /api/maintenance-windows

get/api/maintenance-windows

Request

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

Query parameters

websiteIdstring

Numeric website id; only windows that apply to it.

icmpMonitorIdstring

Numeric ICMP monitor id; only windows that apply to it.

smtpMonitorIdstring

Numeric SMTP monitor id; only windows that apply to it.

sshMonitorIdstring

Numeric SSH monitor id; only windows that apply to it.

tcpMonitorIdstring

Numeric TCP monitor id; only windows that apply to it.

ftpMonitorIdstring

Numeric FTP monitor id; only windows that apply to it.

imapPopMonitorIdstring

Numeric IMAP/POP monitor id; only windows that apply to it.

dnsMonitorIdstring

Numeric DNS monitor id; only windows that apply to it.

customerIpIdstring

Numeric customer IP id; only windows that apply to it.

customerDomainIdstring

Numeric customer domain id; only windows that apply to it.

customerIdstring

Numeric customer id; only windows that apply to it.

organizationIdstring

Numeric organization id; only windows that apply to it.

activeOnly'true' | 'false'
format'json' | 'csv'

csv answers text/csv instead of JSON.

download'0' | '1'

Response

OK

idinteger required
publicIdstring uuid required
websiteIdinteger nullable required

Legacy single website target.

customerIpIdinteger nullable required

Legacy single customer IP target.

customerIdinteger nullable required

null for organization-wide tag windows.

organizationIdinteger nullable required

Set only for organization-wide tag windows.

namestring required
descriptionstring nullable required
startTimestring date-time required
endTimestring date-time required
isRecurringboolean required
isActiveboolean required
timezonestring required

IANA zone the recurrence is read in.

createdBystring nullable required
createdAtstring date-time required
updatedAtstring date-time required
icmpMonitorIdinteger nullable required
smtpMonitorIdinteger nullable required
sshMonitorIdinteger nullable required
tcpMonitorIdinteger nullable required
ftpMonitorIdinteger nullable required
imapPopMonitorIdinteger nullable required
dnsMonitorIdinteger nullable required
customerDomainIdinteger 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.

targetNamestring nullable required
customerNamestring nullable required
websiteobject nullable required

Deprecated: use websiteSummary.

customerPublicIdstring uuid nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.