• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Maintenance windows

Settings API - Maintenance windows schema table

Maintenance windows (builtin:alerting.maintenance-window)

Maintenance windows are typically planned, recurring periods of system downtime during which your DevOps team can perform preventative maintenance and system upgrades outside of peak traffic hours.

To avoid having Dynatrace report on any performance anomalies that may result from such events, set up maintenance windows below that correspond with your organization's maintenance window schedule.

Schema IDSchema groupsScope
builtin:alerting.maintenance-window
  • group:maintenance
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:alerting.maintenance-window
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:alerting.maintenance-window
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:alerting.maintenance-window

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean

The status of the maintenance window. If false, it is not considered during the maintenance window evaluation.

required
generalProperties-GeneralProperties-required
schedule-Schedule-required
filters-set

Add filters to limit the scope of maintenance to only select matching entities. If no filter is defined, the maintenance window is valid for the whole environment. Each filter is evaluated separately (OR).

required

Request body objects

The GeneralProperties object
PropertyLabelTypeDescriptionRequired
nameNametext-required
descriptionDescriptiontext

A short description of the maintenance purpose.

optional
maintenanceTypeMaintenance typeenum

Whether the maintenance is planned or unplanned.

required
suppressionProblem detection and alertingenum

Defines if alerting or problem generation is disabled.

  • Detect problems and alert: Problems are generated and alerted.
  • Detect problems but don't alert: Problems are generated but no alerts are sent out.
  • Disable problem detection during maintenance: Neither problems are generated nor alerts are sent out.
required
disableSyntheticMonitorExecutionDisable synthetic monitor executionboolean

Disables the execution of the synthetic monitors that are within the scope of this maintenance window.

required
The TimeWindow object
PropertyLabelTypeDescriptionRequired
startTimeStart timelocal_time-required
endTimeEnd timelocal_time-required
timeZoneTimezonetime_zone-required
The RecurrenceRange object
PropertyLabelTypeDescriptionRequired
scheduleStartDateStart datelocal_date-required
scheduleEndDateEnd datelocal_date-required
The OnceRecurrence object
PropertyLabelTypeDescriptionRequired
startTimeStart timelocal_date_time-required
endTimeEnd timelocal_date_time-required
timeZoneTimezonetime_zone-required
The DailyRecurrence object
PropertyLabelTypeDescriptionRequired
timeWindowTime windowTimeWindow-required
recurrenceRangeRecurrence rangeRecurrenceRange-required
The WeeklyRecurrence object
PropertyLabelTypeDescriptionRequired
dayOfWeekDay of weekenum-required
timeWindowTime windowTimeWindow-required
recurrenceRangeRecurrence rangeRecurrenceRange-required
The MonthlyRecurrence object
PropertyLabelTypeDescriptionRequired
dayOfMonthDay of monthinteger

If the selected day does not fall within the month, the maintenance window will be active on the last day of the month.

required
timeWindowTime windowTimeWindow-required
recurrenceRangeRecurrence rangeRecurrenceRange-required
The Schedule object
PropertyLabelTypeDescriptionRequired
scheduleTypeRecurrenceenum

Defines the recurrence type of the maintenance window.

  • Once: One time maintenance window with start and end date time.
  • Daily: Maintenance window occurs every day during the configured time window.
  • Weekly: Maintenance window occurs each week on one day during the configured time window.
  • Monthly: Maintenance window occurs each month on one day during the configured time window.
required
onceRecurrence-OnceRecurrence-required
dailyRecurrence-DailyRecurrence-required
weeklyRecurrence-WeeklyRecurrence-required
monthlyRecurrence-MonthlyRecurrence-required
The Filter object
PropertyLabelTypeDescriptionRequired
entityTypeEntity typetext

Type of entities this maintenance window should match.

If no entity type is selected all entities regardless of the type will match.

optional
entityIdEntitytext

A specific entity that should match this maintenance window.

Note: If an entity type filter value is set, it must be equal to the type of the selected entity. Otherwise this maintenance window will not match.

optional
entityTagsEntity tagsset

Entities which contain all of the configured tags will match this maintenance window.

required
managementZonesManagement zonesset

Entities which are part of all the configured management zones will match this maintenance window.

required