Alert
Manage Alerts.
Find
Find alerts by cloud ID.
Endpoint
HTTP
POST /alert/findAuthorized User Role
userRequest Body
| Field | Type | Notes |
|---|---|---|
| cloudId | string | Cloud ID. |
Query String Options
| Field | Type | Default | Notes |
|---|---|---|---|
| index | string | Index name: primary or gs1. | |
| limit | number | Limit number of results. | |
| next | object | Token for next page. | |
| prev | object | Token for previous page. |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | An array of Alert records. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Alert
| Field | Type | Notes |
|---|---|---|
| seq | string | Alert sequence number to uniquely identify the type of alert. |
| accountId | string | Owning account ID. |
| cloudId | string | Owning device cloud ID. |
| context | object | Alert context of extra information. |
| count | number | Count of triggered actions. |
| id | string | Alert ID. |
| name | string | Alert name based on action trigger name. |
| message | string | Text message regarding alert. |
| severity | string | Alert severity. |
| subject | string | Alert subject. |
| resolved | boolean | Alert resolved. |
| timestamp | date | Alert timestamp. |
Get
Get an alert by ID.
Endpoint
HTTP
POST /alert/getAuthorized User Role
userRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Alert ID. |
Response
Alert Record.
| Field | Type | Notes |
|---|---|---|
| seq | string | Alert sequence number to uniquely identify the type of alert. |
| accountId | string | Owning account ID. |
| cloudId | string | Owning device cloud ID. |
| context | object | Alert context of extra information. |
| count | number | Count of triggered actions. |
| id | string | Alert ID. |
| name | string | Alert name based on action trigger name. |
| message | string | Text message regarding alert. |
| severity | string | Alert severity. |
| subject | string | Alert subject. |
| resolved | boolean | Alert resolved. |
| timestamp | date | Alert timestamp. |
Remove
Remove an alert by ID.
Endpoint
HTTP
POST /alert/removeAuthorized User Role
adminRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Alert ID. |
Update
Update an alert's resolved property by ID.
Endpoint
HTTP
POST /alert/updateAuthorized User Role
adminRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Alert ID. |
| resolved | boolean | Resolved flag. |
Response
Alert Record.
| Field | Type | Notes |
|---|---|---|
| seq | string | Alert sequence number to uniquely identify the type of alert. |
| accountId | string | Owning account ID. |
| cloudId | string | Owning device cloud ID. |
| context | object | Alert context of extra information. |
| count | number | Count of triggered actions. |
| id | string | Alert ID. |
| name | string | Alert name based on action trigger name. |
| message | string | Text message regarding alert. |
| severity | string | Alert severity. |
| subject | string | Alert subject. |
| resolved | boolean | Alert resolved. |
| timestamp | date | Alert timestamp. |