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. Documentation
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 ID | Schema groups | Scope |
---|---|---|
builtin:alerting.maintenance-window |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:alerting.maintenance-window |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:alerting.maintenance-window | |
Environment ActiveGate | https://{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
Property | Type | Description | Required |
---|---|---|---|
Enabledenabled | boolean | The status of the maintenance window. If | required |
generalProperties | GeneralProperties | - | required |
schedule | Schedule | - | required |
filters | Set<Filter> |
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 |
The GeneralProperties
object
Property | Type | Description | Required |
---|---|---|---|
Namename | text | - | required |
Descriptiondescription | text | A short description of the maintenance purpose. | optional |
Maintenance typemaintenanceType | enum | Whether the maintenance is planned or unplanned.
| required |
Problem detection and alertingsuppression | enum | Defines if alerting or problem generation is disabled.
| required |
Disable synthetic monitor executiondisableSyntheticMonitorExecution | boolean | Disables the execution of the synthetic monitors that are within the scope of this maintenance window. | required |
The Schedule
object
Property | Type | Description | Required |
---|---|---|---|
RecurrencescheduleType | enum | Defines the recurrence type of the maintenance window.
| required |
onceRecurrence | OnceRecurrence | - | required |
dailyRecurrence | DailyRecurrence | - | required |
weeklyRecurrence | WeeklyRecurrence | - | required |
monthlyRecurrence | MonthlyRecurrence | - | required |
The Filter
object
Property | Type | Description | Required |
---|---|---|---|
Entity typeentityType | text | Type of entities this maintenance window should match. If no entity type is selected all entities regardless of the type will match. | optional |
EntityentityId | text | 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 |
Entity tagsentityTags | set | Entities which contain all of the configured tags will match this maintenance window. It is recommended to use manual tags. Note: Automatically applied tags may experience delays or inconsistencies due to rule complexity and attribute variability. Entities may not be immediately tagged, impacting filter effectiveness. It is recommended to use manual tags instead. For more information, visit our best practices for tagging documentation page. | required |
Management zonesmanagementZones | set | Entities which are part of all the configured management zones will match this maintenance window. It is recommended to use manual tags instead. Note: Management zones may experience delays or inconsistencies due to rule complexity and attribute variability. Entities may not be immediately assigned to management zones, impacting filter effectiveness. It is recommended to use manual tags instead. For more information, visit our best practices for management zones documentation page. | required |
The OnceRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Start timestartTime | local_date_time | - | required |
End timeendTime | local_date_time | - | required |
TimezonetimeZone | time_zone | - | required |
The DailyRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Time windowtimeWindow | TimeWindow | - | required |
Recurrence rangerecurrenceRange | RecurrenceRange | - | required |
The WeeklyRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Day of weekdayOfWeek | enum |
| required |
Time windowtimeWindow | TimeWindow | - | required |
Recurrence rangerecurrenceRange | RecurrenceRange | - | required |
The MonthlyRecurrence
object
Property | Type | Description | Required |
---|---|---|---|
Day of monthdayOfMonth | integer | If the selected day does not fall within the month, the maintenance window will be active on the last day of the month. | required |
Time windowtimeWindow | TimeWindow | - | required |
Recurrence rangerecurrenceRange | RecurrenceRange | - | required |
The TimeWindow
object
Property | Type | Description | Required |
---|---|---|---|
Start timestartTime | local_time | - | required |
End timeendTime | local_time | - | required |
TimezonetimeZone | time_zone | - | required |
The RecurrenceRange
object
Property | Type | Description | Required |
---|---|---|---|
Start datescheduleStartDate | local_date | - | required |
End datescheduleEndDate | local_date | - | required |