Create alert rule

Create a new alert rule to monitor cloud cost metrics.

Alert rules evaluate cost data against a configured condition and notify subscribers when the condition is met. Two condition types are supported:

  • ANOMALY_DETECTION — Detects unusual cost changes by direction (increases, decreases, or both).
  • THRESHOLDING — Triggers when an aggregated cost metric crosses a static value.

Returns the ruleID of the newly created alert rule.

Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

A unique identifier for an organization

condition
required

Alert triggered by increases and decreases, increases only or decreases only

string
enum

Data source that triggers the alert; omit for report-linked alerts (derived from the report)

dimensions
array of strings

Dimensions for the alert; omit for report-linked alerts (derived from the report)

dimensions
boolean

Alert threshold pre or post tax

filters
array of objects

Filters for the alert; omit for report-linked alerts (derived from the report)

filters
string
required

Alert measure e.g. cost

string
required
length ≥ 1

The name of the alert

string
length ≥ 1

Optional ID of a linked report; when set, the alert derives its query config from the report

subscribers
object
required
slackChannelIDs
array of strings

Slack channel IDs to send notifications to

slackChannelIDs
string
enum
required

Status of the alert, active or inactive

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json