Maintenance Windows

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

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

The Maintenance Window Object

PropertyTypeDescription

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

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

integration_ids

string[]

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

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

Last updated