Skip to main content
POST
/
alerts
Create an alert
curl --request POST \
  --url https://api.togai.com/alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alertTemplateId": "abcd-efgh-ijkl-mnop",
  "interval": "30",
  "entityDetails": {
    "usageMeterId": "um.1zYnCiM9Bpg.lv25y"
  },
  "ownerDetails": {
    "accountId": "account_1"
  },
  "parameters": {
    "threshold": 10
  }
}'
{
  "id": "alert.1zYnCiM9Bpg.lv25y",
  "version": 1,
  "alertId": "alert.1zYnCiM9Bpg.lv25y",
  "description": "Alert1 Description",
  "cronInterval": "30",
  "ownerDetails": {
    "accountId": "account_1"
  },
  "entityDetails": {
    "usageMeterId": "um.1zYnCiM9Bpg.lv25y"
  },
  "parameters": {
    "threshold": 10
  },
  "status": "ACTIVE",
  "createdAt": "2020-01-01T00:00:00Z",
  "updatedAt": "2020-01-01T00:00:00Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Payload to install an alert

alertTemplateId
string
required
interval
integer
required
status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
validity
integer

Validity of the alert in minutes, if null then alert will be valid forever

description
string
entityDetails
object
ownerDetails
object
parameters
object

Response

Response for install alert request

id
string
required

Alert ID

version
integer
required

Alert Version

status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
alertTemplateId
string
required

Alert Template Id

interval
integer
required

Interval

createdAt
string<date-time>
required

Created At

description
string

Alert Description

validity
integer

Validity of the alert in minutes, if null then alert will be valid forever

entityDetails
object
ownerDetails
object
parameters
object
updatedAt
string<date-time>

Updated At

I