Skip to main content
SLO & Service Quality/SLO

CreateBudgetAlert

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

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

Operation ID

CreateBudgetAlert

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Path Parameters

  • sloId
    StringRequired

    Identifier of the SLO objective to attach the alert to.

Body Fields

  • config
    ObjectRequired

    Alert configuration to create for the specified SLO objective.

    • id
      String

      Unique identifier of the budget alert configuration.

      Example: alert-cfg-001

    • sloId
      String

      Identifier of the SLO objective this alert is associated with.

      Example: slo-xyz789

    • consumedPctThreshold
      Long

      Consumption percentage threshold that triggers the alert.

      Example: 80

    • severity
      String

      Severity level of the alert: warning | critical.

      Example: warning

    • notificationChannels
      List

      List of notification channel identifiers to alert.

      Example: item1,item2

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of the budget alert configuration.

    Example: alert-cfg-001

  • sloId
    String

    Identifier of the SLO objective this alert is associated with.

    Example: slo-xyz789

  • consumedPctThreshold
    Long

    Consumption percentage threshold that triggers the alert.

    Example: 80

  • severity
    String

    Severity level of the alert: warning | critical.

    Example: warning

  • notificationChannels
    List

    List of notification channel identifiers to alert.

    Example: item1,item2