Migrate from Maintenance windows API to Settings API
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.
Base URL
| new Settings 2.0 | old Maintenance windows |
|---|---|
/api/v2/settings | /api/config/v1/maintenanceWindows |
Authentication token scope
| new Settings 2.0 | old Maintenance windows |
|---|---|
Read settings (settings.read)Write settings ( settings.write) | Read configuration (ReadConfig)Write configuration ( WriteConfig) |
Parameters
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.
Examples
Here are some examples of differences in API usage.