Settings API - Service-level objective definitions schema table
Service-level objective definitions (builtin:monitoring.slo)
Define custom Service-level objectives (SLOs) to assist in fulfilling your organization’s service-level agreements. Create up to 10000 custom SLOs for this Dynatrace environment.
Schema ID | Schema groups | Scope |
---|---|---|
builtin:monitoring.slo |
| environment |
GET | Managed | https://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoring.slo |
SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:monitoring.slo | |
Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoring.slo |
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 | - | required |
SLO namename | text | - | required |
DescriptioncustomDescription | text | The description of the SLO | optional |
Metric namemetricName | text | - | required |
Define the metric expression that measures the success rate of this SLOmetricExpression | text | For details, see the Metrics page ( | required |
Evaluation typeevaluationType | enum | Select "Aggregate" to have the measurements of this success metric aggregated into a single percentage-rate metric.
| required |
Entity selectorfilter | text | Set a filter parameter (entitySelector) on any GET call to evaluate this SLO against specific services only (for example, type("SERVICE")). For details, see the Entity Selector documentation. | required |
Timeframe during which the SLO is to be evaluatedevaluationWindow | text | Define the timeframe during which the SLO is to be evaluated. For the timeframe you can enter expressions like -1h (last hour), -1w (last week) or complex expressions like -2d to now (last two days), -1d/d to now/d (beginning of yesterday to beginning of today). | required |
Target percentagetargetSuccess | float | Set the target value of the SLO. A percentage below this value indicates a failure. | required |
Warning percentagetargetWarning | float | Set the warning value of the SLO. At the warning state the SLO is fulfilled. However, it is getting close to a failure. | required |
errorBudgetBurnRate | ErrorBudgetBurnRate | - | required |
The ErrorBudgetBurnRate
object
Property | Type | Description | Required |
---|---|---|---|
Burn rate visualization enabledburnRateVisualizationEnabled | boolean | - | required |
Fast-burn thresholdfastBurnThreshold | float | The threshold defines when a burn rate is marked as fast-burning (high-emergency). Burn rates lower than this threshold (and greater than 1) are highlighted as slow-burn (low-emergency). | required |