Component schema

SloSpec

object1 direct reference

Definition

string

Optional description of the SLO, up to 1050 characters.

string

The service this SLO is associated with. A / separates the service namespace from the service name, so payments/eu resolves to namespace payments and name eu, and a value without a slash is just the service name. If a service name itself contains a /, prefix the value with a leading / to treat the rest as a literal name with no namespace; for example /payments/eu resolves to the name payments/eu. If nothing matches, the SLO is simply not linked to a service.

SloIndicator

Inline Service Level Indicator (SLI). An inline indicator is required (indicatorRef is not currently supported).

string

Name of an external SLI. Not currently supported — provide an inline indicator instead. Requests that set indicatorRef are rejected with a 400.

SloTimeWindow[]

Optional. A single rolling time window with a 4w (28d) duration. Only rolling 4w/28d windows are currently supported; calendar-aligned windows and other durations are rejected with a 400. When omitted, a rolling 28d window is used. Note the evaluation window is currently fixed at 28d regardless of the value provided.

SloBudgetingMethodrequired

Only Occurrences is currently supported. Timeslices and RatioTimeslices are not currently supported and requests using them are rejected with a 400.

"Occurrences""Timeslices""RatioTimeslices"

SloObjective[]required

Thresholds for the SLO. Exactly one objective is supported; multiple or composite objectives are not currently supported and requests declaring more than one objective are rejected with a 400.

SloAlertPolicy[]

Alert policies for this SLO, following the OpenSLO v1 specification. Not supported by Dash0. This field is accepted for OpenSLO compatibility, but any alert policies are ignored: they are not stored, not evaluated, and not returned when reading the SLO back.

Used by 1

These schemas and endpoints reference this type directly.

SchemaSloDefinition

json

OpenAPI source1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
{
  "properties": {
    "description": {
      "description": "Optional description of the SLO, up to 1050 characters.",
      "type": "string",
      "maxLength": 1050
    },
    "service": {
      "description": "The service this SLO is associated with. A `/` separates the service namespace from the service name, so `payments/eu` resolves to namespace `payments` and name `eu`, and a value without a slash is just the service name. If a service name itself contains a `/`, prefix the value with a leading `/` to treat the rest as a literal name with no namespace; for example `/payments/eu` resolves to the name `payments/eu`. If nothing matches, the SLO is simply not linked to a service.",
      "type": "string"
    },
    "indicator": {
      "$ref": "#/components/schemas/SloIndicator",
      "description": "Inline Service Level Indicator (SLI). An inline indicator is required (indicatorRef is not currently supported)."
    },
    "indicatorRef": {
      "description": "Name of an external SLI. Not currently supported — provide an inline indicator instead. Requests that set indicatorRef are rejected with a 400.",
      "type": "string"
    },
    "timeWindow": {
      "description": "Optional. A single rolling time window with a `4w` (28d) duration. Only rolling `4w`/`28d` windows are currently supported; calendar-aligned windows and other durations are rejected with a 400. When omitted, a rolling 28d window is used. Note the evaluation window is currently fixed at 28d regardless of the value provided.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SloTimeWindow"
      },
      "minItems": 1,
      "maxItems": 1
    },
    "budgetingMethod": {
      "$ref": "#/components/schemas/SloBudgetingMethod",
      "description": "Only `Occurrences` is currently supported. `Timeslices` and `RatioTimeslices` are not currently supported and requests using them are rejected with a 400."
    },
    "objectives": {
      "description": "Thresholds for the SLO. Exactly one objective is supported; multiple or composite objectives are not currently supported and requests declaring more than one objective are rejected with a 400.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SloObjective"
      },
      "minItems": 1
    },
    "alertPolicies": {
      "description": "Alert policies for this SLO, following the OpenSLO v1 specification.\nNot supported by Dash0. This field is accepted for OpenSLO compatibility, but any alert policies are ignored: they are not stored, not evaluated, and not returned when reading the SLO back.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SloAlertPolicy"
      }
    }
  },
  "required": [
    "budgetingMethod",
    "objectives"
  ]
}