PATCH
/
alerts
/
{alert_id}
Update an alert
curl --request PATCH \
  --url https://api.togai.com/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "INACTIVE"
}'
{
  "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.

Path Parameters

​
alert_id
string
required
Example:

"alert.20aUyEZSuYq.SoGbS"

Body

application/json

Payload to update alert

The body is of type object.

Response

200
application/json

Response for install alert request

The response is of type object.

PATCH
/
alerts
/
{alert_id}
Update an alert
curl --request PATCH \
  --url https://api.togai.com/alerts/{alert_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "INACTIVE"
}'
{
  "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.

Path Parameters

​
alert_id
string
required
Example:

"alert.20aUyEZSuYq.SoGbS"

Body

application/json

Payload to update alert

The body is of type object.

Response

200
application/json

Response for install alert request

The response is of type object.