GET
/
alerts
List alerts
curl --request GET \
  --url https://api.togai.com/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Authorizations

​
Authorization
string
header
required

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

Response

200
application/json

Response for list Alert request

The response is of type object.

GET
/
alerts
List alerts
curl --request GET \
  --url https://api.togai.com/alerts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ],
  "nextToken": "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="
}

Authorizations

​
Authorization
string
header
required

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

Response

200
application/json

Response for list Alert request

The response is of type object.