Skip to main content
API Explorer|API Explorer
SLO & Service Quality/SLO
POSTSLOSince 1.0SynchronousAuth Required

CreateBudgetAlert

Create a burn-rate alert configuration for an SLO objective.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • sloIdStringRequired

    Identifier of the SLO objective to attach the alert to.

Body Fields

  • configObjectRequired

    Alert configuration to create for the specified SLO objective.

    • idString

      Unique identifier of the budget alert configuration.

      Example: alert-cfg-001

    • sloIdString

      Identifier of the SLO objective this alert is associated with.

      Example: slo-xyz789

    • consumedPctThresholdLong

      Consumption percentage threshold that triggers the alert.

      Example: 80

    • severityString

      Severity level of the alert: warning | critical.

      Example: warning

    • notificationChannelsList

      List of notification channel identifiers to alert.

      Example: item1,item2

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the budget alert configuration.

    Example: alert-cfg-001

  • sloIdString

    Identifier of the SLO objective this alert is associated with.

    Example: slo-xyz789

  • consumedPctThresholdLong

    Consumption percentage threshold that triggers the alert.

    Example: 80

  • severityString

    Severity level of the alert: warning | critical.

    Example: warning

  • notificationChannelsList

    List of notification channel identifiers to alert.

    Example: item1,item2

Endpoint

POST/api/v1/slo/objectives/{sloId}/budget-alerts

/api/v1/slo/objectives/{sloId}/budget-alerts

Operation ID

CreateBudgetAlert

Permalink

Request Example

curl -X POST '{host}/api/v1/slo/objectives/{sloId}/budget-alerts' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"config":{"id":"alert-cfg-001","sloId":"slo-xyz789","consumedPctThreshold":80.0,"severity":"warning","notificationChannels":"item1,item2"}}'

Response Example

200
{
  "id": "alert-cfg-001",
  "sloId": "slo-xyz789",
  "consumedPctThreshold": 80.0,
  "severity": "warning",
  "notificationChannels": []
}

Change History

This API has no change history records yet.

View all change history