Migrate from Alerting profiles API to Settings API
Alerting profiles API has been deprecated with Dynatrace version 1.249. Its replacement is Settings API with the Problem alerting profiles (builtin:alerting.profile) 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 Alerting profiles |
|---|---|
/api/v2/settings | /api/config/v1/alertingProfiles |
Authentication token scope
| new Settings 2.0 | old Alerting profiles |
|---|---|
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 alerting profile 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. The content of the value is essentially the same as the configuration in the deprecated Alerting profiles API. To learn about the parameters of the alerting profile configuration, query the Problem alerting profiles (builtin:alerting.profile) schema with the GET a schema request.
Examples
Here are some examples of differences in API usage.