Skip to main content
GET
/
cost_alerts
/
{cost_alert_token}
Get cost alert by token
curl --request GET \
  --url https://api.vantage.sh/v2/cost_alerts/{cost_alert_token} \
  --header 'Authorization: Bearer <token>'
{
  "token": "cstm_alrt_rl_db54d080e58bf82a",
  "title": "Default Alert Rule",
  "email_recipients": [],
  "slack_channels": [],
  "teams_channels": [],
  "created_at": "2024-04-21T15:19:49.598Z",
  "updated_at": "2025-04-21T15:19:49.598Z",
  "workspace_token": "wrkspc_c94c58cd1f9a6314",
  "interval": "day",
  "threshold": 1000,
  "unit_type": "currency",
  "report_tokens": [
    "rprt_7c787dfc49b17876"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
cost_alert_token
string
required

The token of the Cost Alert.

Response

Get a Cost Alert

CostAlert model

​
token
string
​
title
string
​
email_recipients
string[]

The email addresses that will receive the alert.

​
slack_channels
string[]

The Slack channels that will receive the alert. Make sure your slack integration is connected at https://console.vantage.sh/settings/slack.

​
teams_channels
string[]

The Microsoft Teams channels that will receive the alert. Make sure your teams integration is connected at https://console.vantage.sh/settings/microsoft_teams.

​
created_at
string

The date and time, in UTC, for when the alert was created. ISO 8601 Formatted.

Example:

"2023-10-01T12:00:00Z"

​
updated_at
string

The date and time, in UTC, for when the alert was last updated. ISO 8601 Formatted.

Example:

"2023-10-01T12:00:00Z"

​
workspace_token
string

The ID of the organization that owns the CostAlert.

​
interval
string

The period of time used to compare costs. Options are 'day', 'week', 'month', 'quarter'.

​
threshold
number

The cost change threshold to alert on.

​
unit_type
string

The unit type used to compare costs. Options are 'currency' or 'percentage'.

​
report_tokens
string[]

The tokens of the reports to alert on.