• Home
  • Dynatrace API
  • Environment
  • Settings
  • Schemas
  • Service-level objective definitions

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 IDSchema groupsScope
builtin:monitoring.slo
  • group:cloud-automation.monitoring.slo
  • group:cloud-automation
environment
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:monitoring.slo
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:monitoring.slo
Environment ActiveGatehttps://{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

PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
nameSLO nametext-required
customDescriptionDescriptiontext

The description of the SLO

optional
metricNameMetric nametext

Once created, metric keys cannot be changed

required
metricExpressionDefine the metric expression that measures the success rate of this SLOtext

For details, see the Metrics page.

required
evaluationTypeEvaluation typeenum

Select "Aggregate" to have the measurements of this success metric aggregated into a single percentage-rate metric.

required
filterEntity selectortext

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
evaluationWindowTimeframe during which the SLO is to be evaluatedtext

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
targetSuccessTarget percentagefloat

Set the target value of the SLO. A percentage below this value indicates a failure.

required
targetWarningWarning percentagefloat

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

Request body objects

The FlagDefaultTrue object
PropertyLabelTypeDescriptionRequired
enabledEnabledboolean-required
The ErrorBudgetBurnRate object
PropertyLabelTypeDescriptionRequired
burnRateVisualizationEnabledBurn rate visualization enabledboolean-required
fastBurnThresholdFast-burn thresholdfloat

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