Skip to main content
POST
/
budget_alerts
Create budget alert
curl --request POST \
  --url https://api.vantage.sh/v2/budget_alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "budget_tokens": [
    "<string>"
  ],
  "threshold": 123,
  "duration_in_days": "<string>",
  "user_tokens": [
    "<string>"
  ],
  "period_to_track": "<string>",
  "recipient_channels": [
    "<string>"
  ]
}
'
{
  "token": "<string>",
  "budget_tokens": [
    ""
  ],
  "created_at": "2024-03-19T00:00:00Z",
  "workspace_token": "<string>",
  "user_token": "<string>",
  "user_tokens": [
    ""
  ],
  "duration_in_days": "<string>",
  "threshold": "75",
  "period_to_track": "start_of_the_month",
  "integration_provider": "slack",
  "recipient_channels": ""
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
budget_tokens
string[]
required

The tokens of the Budget that has the alert.

​
threshold
integer<int32>
required

The threshold amount that must be met for the alert to fire.

​
duration_in_days
string
required

The number of days from the start or end of the month to trigger the alert if the threshold is reached. For the full month, pass an empty value.

​
user_tokens
string[]

The tokens of the users that receive the alert.

​
period_to_track
string

The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Defaults to start_of_the_month if not passed. Possible values: start_of_the_month, end_of_the_month.

​
recipient_channels
string[]

The channels receiving the alerts. Requires an integration provider to be connected.

Response

BudgetAlert model

​
token
string
​
budget_tokens
string[]

The tokens for the Budgets that the Budget Alert is monitoring to trigger alerts on.

​
created_at
string

The date and time, in UTC, the Budget Alert was created. ISO 8601 Formatted.

Example:

"2024-03-19T00:00:00Z"

​
workspace_token
string

The token for the Workspace the ResourceReport is a part of.

​
user_token
string

The token for the User who created this BudgetAlert.

​
user_tokens
string[]

The Users that receive the alert.

​
duration_in_days
string

The number of days from the start or end of the month to trigger the alert if the threshold is reached.

​
threshold
string

Alerts only send if they reach this number (as a percentage). When threshold is 100, that means alerts are triggered once costs reach 100% of the budget.

Example:

"75"

​
period_to_track
string

The period tracked on the alert. Used with duration_in_days to determine the time window of the alert. Possible values: start_of_the_month, end_of_the_month.

Example:

"start_of_the_month"

​
integration_provider
string

The provider used for sending alerts. This must be configured in the console. Possible values are: slack, microsoft_graph.

Example:

"slack"

​
recipient_channels
string

The channels receiving the alerts. Requires an integration provider to be connected.

Example:

""