Service-level objectives API - PUT an SLO
Updates service-level objective (SLO) parameters.
The request consumes an application/json payload.
| PUT | SaaS | https://{your-environment-id}.live.dynatrace.com/api/v2/slo/{id} |
| Environment ActiveGateCluster ActiveGate | https://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/slo/{id} |
Authentication
To execute this request, you need an access token with slo.write scope.
To learn how to obtain and use it, see Tokens and authentication.
Parameters
The ID of the required SLO.
The JSON body of the request. Contains the updated parameters of the SLO.
Request body objects
The SloConfigItemDtoImpl object
The description of the SLO.
The SLO is enabled (true) or disabled (false).
If not defined, the SLO is disabled by default.
Error budget burn rate configuration of a service-level objective (SLO).
The evaluation type of the SLO.
AGGREGATE
The entity filter for the SLO evaluation. The total length of the entitySelector string in SLOs is limited to 1,000 characters. Use the syntax of entity selector.
DEPRECATED
The total count metric (the denominator in rate calculation).
Required when the useRateMetric is set to false.
The percentage-based metric expression for the calculation of the SLO.
The name that is used to create SLO func metrics keys. Once created, metric name cannot be changed.
DEPRECATED
The metric for the count of successes (the numerator in rate calculation).
Required when the useRateMetric is set to false.
DEPRECATED
The percentage-based metric for the calculation of the SLO.
Required when the useRateMetric is set to true.
The name of the SLO.
The target value of the SLO.
The timeframe for the SLO evaluation. Use the syntax of the global timeframe selector.
DEPRECATED
The type of the metric to use for SLO calculation:
true: An existing percentage-based metric.false: A ratio of two metrics.
For a list of available metrics, see Built-in metric page or try the GET metrics API call.
The warning value of the SLO.
At warning state the SLO is still fulfilled but is getting close to failure.
The SloBurnRateConfig object
Error budget burn rate configuration of a service-level objective (SLO).
The error budget burn rate calculation is enabled (true) or disabled (false).
In case of false, no calculated values will be present here.
If not defined, the error budget burn rate calculation is disabled by default.
The threshold between a slow and a fast burn rate.
Request body JSON model
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"description": "Rate of successful payments per week","enabled": true,"errorBudgetBurnRate": {"burnRateVisualizationEnabled": true,"fastBurnThreshold": 1.5},"evaluationType": "AGGREGATE","filter": "type(\"SERVICE\")","metricDenominator": "builtin:service.requestCount.server","metricExpression": "(100)*(builtin:service.errors.server.successCount:splitBy())/(builtin:service.requestCount.server:splitBy())","metricName": "payment_service_availability","metricNumerator": "builtin:service.errors.server.successCount","metricRate": "builtin:service.successes.server.rate","name": "Payment service availability","target": 95,"timeframe": "-1d","useRateMetric": true,"warning": 97.5}
Response
Response codes
Success
Failed. The requested resource doesn't exist.