Docs
WebsiteLoginFree Trial
  • Getting Started
    • OnCall Users
    • Team Admins
    • Account Admins
  • Architecture Guide
  • Common UI Design Patterns
  • Alerts
  • Teams
  • Schedules
  • Escalation Policies
  • Integrations
  • Broadcasts
  • Users
  • Notifications
  • Reports
  • Billing
  • Accounts
  • Stakeholders
  • Maintenance Windows
  • Routers
  • Notification Rules
  • Single Sign On (SSO)
  • Integration Guides
    • Introduction
    • 66uptime
    • Apex Ping
    • AppDynamics
    • Auvik
    • AWS CloudWatch
    • Azure Monitor
    • Cloudflare
    • Cronitor
    • Datadog
    • Dead Man's Snitch
    • Echoes HQ
    • ElastAlert
    • Email
    • Form
    • Freshdesk
    • Freshservice
    • Google Hangouts Chat
    • Grafana
    • Healthchecks.io
    • HetrixTools
    • Honeybadger
    • Hydrozen
    • Jira Server
    • JotForm
    • Kapacitor
    • LogicMonitor
    • Mattermost
      • Outgoing Webhook
      • Post to Channel
    • Meta Workplace
    • Microsoft Teams
    • New Relic
    • Outgoing Webhook
    • Pingdom
    • Prometheus
    • PRTG Network Monitor
    • Pulsetic
    • Sentry
    • ServerGuard24
    • Site24x7
    • Slack
      • Notifications
      • Outgoing Webhook
      • Post to Channel
    • SolarWinds
    • Stackdriver
    • StatusCake
    • Twilio
      • Incoming SMS
      • Live Call Routing
    • Typeform
    • Uptime
    • Uptime Kuma
    • UptimeRobot
    • Webhook
    • Zendesk
  • API
    • Introduction
    • Authentication
    • Errors
    • Pagination and Filters
    • Common Model Attributes
    • Account Users
    • Alerts
    • Broadcasts
    • Comments
    • Escalation Policies
    • Events
    • Integrations
    • Logs
    • Maintenance Windows
    • Notification Rules
    • Routers
    • Schedules
    • Teams
    • Users
  • Command Line Interface (CLI)
    • PagerTree CLI: Command Line Interface
Powered by GitBook
On this page
  • The Maintenance Window Object
  • Create a Maintenance Window
  • Retrieve a Maintenance Window
  • Update a Maintenance Window
  • Delete a Maintenance Window
  • List all Maintenance Windows

Was this helpful?

  1. API

Maintenance Windows

PreviousLogsNextNotification Rules

Last updated 2 years ago

Was this helpful?

  • A is used to ignore incoming requests from during a specified time frame.

  • A maintenance window can be attached to one or more integrations.

The Maintenance Window Object

Property
Type
Description

name

string

The name of the maintenance window.

start_datetime

datetime

The start datetime of this maintenance window.

end_datetime

datetime

The end datetime of this maintenance window.

time_zone

string

integration_ids

string[]

Create a Maintenance Window

POST https://api.pagertree.com/api/v4/maintenance_windows

Allowed Parameters

def maintenance_window_params
  params.permit(
    :name,
    :description,
    :start_datetime,
    :end_datetime,
    :time_zone,
    integration_ids: []
  )
end

Required Parameters

  • name

  • start_datetime

  • end_datetime

  • time_zone

  • at least 1 integration_id

Retrieve a Maintenance Window

GET https://api.pagertree.com/api/v4/maintenance_windows/:id

Update a Maintenance Window

PUT https://api.pagertree.com/api/v4/maintenance_windows/:id

Delete a Maintenance Window

DELETE https://api.pagertree.com/api/v4/maintenance_windows/:id

List all Maintenance Windows

GET https://api.pagertree.com/api/v4/maintenance_windows

The time zone this maintenance window will respect. (See for the list of all available time zone names.)

The IDs of the this maintenance window affects during the specified time frame.

maintenance window
integrations
integrations
event time zones