Component schema

SloAlertPolicySpec

object1 direct reference

Definition

string

Description of the alert policy, up to 1050 characters.

booleanrequired

Whether to trigger the alert when the condition is breaching.

booleanrequired

Whether to trigger the alert when the condition is resolved.

booleanrequired

Whether to trigger the alert when no data is available.

SloAlertCondition[]required

Alert conditions (max one condition per OpenSLO v1).

SloAlertNotificationTarget[]required

Notification targets for this alert policy.

Used by 1

These schemas and endpoints reference this type directly.

SchemaSloAlertPolicy

json

OpenAPI source123456789101112131415161718192021222324252627282930313233343536373839404142
{
  "properties": {
    "description": {
      "description": "Description of the alert policy, up to 1050 characters.",
      "type": "string",
      "maxLength": 1050
    },
    "alertWhenBreaching": {
      "description": "Whether to trigger the alert when the condition is breaching.",
      "type": "boolean"
    },
    "alertWhenResolved": {
      "description": "Whether to trigger the alert when the condition is resolved.",
      "type": "boolean"
    },
    "alertWhenNoData": {
      "description": "Whether to trigger the alert when no data is available.",
      "type": "boolean"
    },
    "conditions": {
      "description": "Alert conditions (max one condition per OpenSLO v1).",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SloAlertCondition"
      }
    },
    "notificationTargets": {
      "description": "Notification targets for this alert policy.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SloAlertNotificationTarget"
      }
    }
  },
  "required": [
    "alertWhenBreaching",
    "alertWhenResolved",
    "alertWhenNoData",
    "conditions",
    "notificationTargets"
  ]
}