The Maintenance windows API has been deprecated with Dynatrace version 1.240. Its replacement is Settings API with the Maintenance windows (builtin:alerting.maintenance-window
) schema. We recommend that you migrate to the new API at your earliest convenience.
The migration affects endpoint URLs, query parameters, and response/request body parameters, as well as the scope of the token for request authentication.
/api/v2/settings
/api/config/v1/maintenanceWindows
settings.read
)settings.write
)ReadConfig
)WriteConfig
)To learn about new query/body parameters, see the documentation of individual requests in Settings API.
In the Settings 2.0 framework, each maintenance window is represented by a settings object. An object contains some metadata (like the scope or creation timestamp) and the configuration itself, encapsulated in the value object. To learn about the parameters of the maintenance window configuration, query the Maintenance windows (builtin:alerting.maintenance-window
) schema with the GET a schema request.
Here are some examples of differences in API usage.
To list all maintenance windows, you need the GET objects request. In query parameters, set schemaIds to builtin:alerting.maintenance-window
and scope to environment
.
GET https://mySampleEnv.live.dynatrace.com/api/v2/settings/objects?schemaIds=builtin:alerting.maintenance-window&scopes=environment
{"items": [{"objectId":"vu9U3hXa3q0AAAABACNidWlsdGluOmFsZXJ0aW5nLm1haW50ZW5hbmNlLXdpbmRvdwAGdGVuYW50AAZ0ZW5hbnQAJDgwMzdjNWM3LTdkNTgtNGQyYy04YzJkLWViMTYxMTBkZTE2Mr7vVN4V2t6t","value": {"enabled": true,"generalProperties": {"name": "Synthetic scaling","description": "Maintenance window for adaptations of Synthetic monitors","maintenanceType": "PLANNED","suppression": "DETECT_PROBLEMS_DONT_ALERT","disableSyntheticMonitorExecution": false},"schedule": {"scheduleType": "ONCE","onceRecurrence": {"startTime": "2022-12-22T09:00:00","endTime": "2022-12-22T12:00:00","timeZone": "UTC"}},"filters": [{"entityType": "HOST","entityTags": ["[AWS]Usage:Synthetic"],"managementZones": []}]}},{"objectId": "vu9U3hXa3q0AAAABACNidWlsdGluOmFsZXJ0aW5nLm1haW50ZW5hbmNlLXdpbmRvdwAGdGVuYW50AAZ0ZW5hbnQAJDE3NDgxMWYxLWQ2NjYtNGJhNy1iZmU3LTk5ZGYzMjIyNjY3Mr7vVN4V2t6t","value": {"enabled": true,"generalProperties": {"name": "Issue with pre-production environment","maintenanceType": "UNPLANNED","suppression": "DONT_DETECT_PROBLEMS","disableSyntheticMonitorExecution": false},"schedule": {"scheduleType": "ONCE","onceRecurrence": {"startTime": "2022-12-10T10:00:00","endTime": "2022-12-10T14:00:00","timeZone": "Europe/Vienna"}},"filters": [{"entityType": "SERVICE","entityTags": ["Env-pre-prod"],"managementZones": []},{"entityType": "PROCESS_GROUP","entityTags": ["Env-pre-prod"],"managementZones": []}]}}],"totalCount": 2,"pageSize": 100,}
To create a maintenance window, you need the POST an object request. In the request body, set schemaId to builtin:alerting.maintenance-window
and scope to environment
. Provide the maintenance window configuration in the value object.
The response contains the ID of the object that you need to modify the settings.
POST https://mySampleEnv.live.dynatrace.com/api/v2/settings/objects
[{"schemaId": "builtin:alerting.maintenance-window","scope": "environment","value": {"enabled": true,"generalProperties": {"name": "Sample maintenance window","maintenanceType": "PLANNED","suppression": "DETECT_PROBLEMS_AND_ALERT","disableSyntheticMonitorExecution": false},"schedule": {"scheduleType": "MONTHLY","monthlyRecurrence": {"dayOfMonth": 1,"timeWindow": {"startTime": "06:00:00","endTime": "06:30:00","timeZone": "Europe/Vienna"},"recurrenceRange": {"scheduleStartDate": "2022-01-01","scheduleEndDate": "2022-12-31"}}},"filters": [{"entityType": "SERVICE","entityTags": ["stage:pre-production"],"managementZones": []}]}}]
[{"code": 200,"objectId": "vu9U3hXa3q0AAAABACNidWlsdGluOmFsZXJ0aW5nLm1haW50ZW5hbmNlLXdpbmRvdwAGdGVuYW50AAZ0ZW5hbnQAJDVhMjg2NmE5LTJjZjQtMzIwZC1hNjMxLTI0NTAwYTQ4NmU5Zr7vVN4V2t6t"}]
To edit a maintenance window, you need the PUT an object request.
PUT https://mySampleEnv.live.dynatrace.com/api/v2/settings/objects/vu9U3hXa3q0AAAABABhidWlsdGluOmFsZXJ0aW5nLnByb2ZpbGUABnRlbmFudAAGdGVuYW50ACQzYjAwNDMwOC01ZTZjLTNkNGMtOTNjMS01ZTBiOWRhZTlhZjW-71TeFdrerQ
{"schemaId": "builtin:alerting.maintenance-window","scope": "environment","value": {"enabled": true,"generalProperties": {"name": "Sample maintenance window","maintenanceType": "PLANNED","suppression": "DETECT_PROBLEMS_AND_ALERT","disableSyntheticMonitorExecution": false},"schedule": {"scheduleType": "MONTHLY","monthlyRecurrence": {"dayOfMonth": 5,"timeWindow": {"startTime": "01:00:00","endTime": "01:30:00","timeZone": "Europe/Vienna"},"recurrenceRange": {"scheduleStartDate": "2022-01-01","scheduleEndDate": "2022-12-31"}}},"filters": [{"entityType": "SERVICE","entityTags": ["stage:pre-production"],"managementZones": ["5561909168316319665"]}]}}
[{"code": 200,"objectId": "vu9U3hXa3q0AAAABABhidWlsdGluOmFsZXJ0aW5nLnByb2ZpbGUABnRlbmFudAAGdGVuYW50ACQzYjAwNDMwOC01ZTZjLTNkNGMtOTNjMS01ZTBiOWRhZTlhZjW-71TeFdrerQ"}]