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 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 | Label | Type | Description | Required |
|---|---|---|---|---|
| enabled | Enabled | boolean | The status of the maintenance window. If | 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
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| name | Name | text | - | required |
| description | Description | text | A short description of the maintenance purpose. | optional |
| maintenanceType | Maintenance type | enum | Whether the maintenance is planned or unplanned. | required |
| suppression | Problem detection and alerting | enum | Defines if alerting or problem generation is disabled.
| required |
| disableSyntheticMonitorExecution | Disable synthetic monitor execution | boolean | Disables the execution of the synthetic monitors that are within the scope of this maintenance window. | required |
The TimeWindow object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| startTime | Start time | local_time | - | required |
| endTime | End time | local_time | - | required |
| timeZone | Timezone | time_zone | - | required |
The RecurrenceRange object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| scheduleStartDate | Start date | local_date | - | required |
| scheduleEndDate | End date | local_date | - | required |
The OnceRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| startTime | Start time | local_date_time | - | required |
| endTime | End time | local_date_time | - | required |
| timeZone | Timezone | time_zone | - | required |
The DailyRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| timeWindow | Time window | TimeWindow | - | required |
| recurrenceRange | Recurrence range | RecurrenceRange | - | required |
The WeeklyRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| dayOfWeek | Day of week | enum | - | required |
| timeWindow | Time window | TimeWindow | - | required |
| recurrenceRange | Recurrence range | RecurrenceRange | - | required |
The MonthlyRecurrence object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| dayOfMonth | Day of month | 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 |
| timeWindow | Time window | TimeWindow | - | required |
| recurrenceRange | Recurrence range | RecurrenceRange | - | required |
The Schedule object
| Property | Label | Type | Description | Required |
|---|---|---|---|---|
| scheduleType | Recurrence | 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 | Label | Type | Description | Required |
|---|---|---|---|---|
| entityType | Entity type | text | Type of entities this maintenance window should match. If no entity type is selected all entities regardless of the type will match. | optional |
| entityId | Entity | 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 |
| entityTags | Entity tags | set | Entities which contain all of the configured tags will match this maintenance window. | required |
| managementZones | Management zones | set | Entities which are part of all the configured management zones will match this maintenance window. | required |