Maintenance Window API

• Maintenance Windows

  • List Methods
  • Expand Methods

  • POSTCreate A Maintenance Window/maintenance/1.0
    Create a new maintenance window and configure monitors to utilize it
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    name		string	The name of the maintenance window
    description		string	A description of what this maintenance window is for
    recurrence	1WMY	enumerated	How often will this maintenance window repeat or if it is a one-time window. W for weekly, M for monthly, Y for yearly, or 1 for one-time
    alert	truefalse	enumerated	Allow monitors to alert during the maintenance window
    tz_offset		string	tz_offset refers to Timezone is a geographic region within which the time is used. Example: '480' is (GMT-08:00) Pacific Time (US & Canada) , following are the valid timezones ['720', '660', '600', '540', '480', '420', '360', '300', '270', '240', '210', '180', '120', '60', '0', '-60', '-120', '-180', '-210', '-240', '-270', '-300', '-330', '-345', '-360', '-390', '-420', '-480', '-540', '-570', '-600', '-660', '-720', '-780']
    startDate		string	ISO 8601 time format in UTC indicating what time the maintenance window will start. Example: 2012-05-10T13:34:00
    monitor		string	An array of valid monitor IDs which will be affected by this maintenance window
    duration		integer	How long (in minutes) the maintenance window will last

    
    
  • GETList Maintenance Windows/maintenance/1.0
    Retrieve a list of all maintenance windows as associated to your account
    
    
    
  • GETGet a Maintenance Window/maintenance/1.0/:maintenanceID
    Retrieves information for a specific maintennce window associated with your account. The maintenance window id that is returned is used to make other api calls.
    
    

    Input Variables:

    URL Variable	Value
    maintenanceID

    
    
    
  • PUTUpdate A Maintenance Window/maintenance/1.0/:maintenanceID
    Modify an existing maintenance window
    
    

    Input Variables:

    URL Variable	Value
    maintenanceID

    
    

    Parameter	Value	Type	Description
    name		string	The name of the maintenance window
    description		string	A description of what this maintenance window is for
    recurrence	1WMY	enumerated	How often will this maintenance window repeat or if it is a one-time window. W for weekly, M for monthly, Y for yearly, or 1 for one-time
    alert	truefalse	enumerated	Allow monitors to alert during the maintenance window
    tz_offset		string	tz_offset refers to Timezone is a geographic region within which the time is used. Example: '480' is (GMT-08:00) Pacific Time (US & Canada) , following are the valid timezones ['720', '660', '600', '540', '480', '420', '360', '300', '270', '240', '210', '180', '120', '60', '0', '-60', '-120', '-180', '-210', '-240', '-270', '-300', '-330', '-345', '-360', '-390', '-420', '-480', '-540', '-570', '-600', '-660', '-720', '-780']
    startDate		string	ISO 8601 time format in UTC indicating what time the maintenance window will start. Example: 2012-05-10T13:34:00
    monitor		string	An array of valid monitor IDs which will be affected by this maintenance window
    duration		integer	How long (in minutes) the maintenance window will last

    
    
  • DELETEDelete Maintenance Window/maintenance/1.0/:maintenanceID
    Deletes a given maintenance window
    
    

    Input Variables:

    URL Variable	Value
    maintenanceID