Alert
Manage Alerts.
Find
Find alerts by matching properties and query parameters.
Endpoint
HTTP
POST /alert/findAuthorized User Role
userRequest Body
None.
Query String Options
| Field | Type | Default | Role | Notes |
|---|---|---|---|---|
| index | string | owner | Database index name: primary or gs1. | |
| limit | number | Number of items to retrieve. | ||
| next | object | Pagination token for the next page. | ||
| prev | object | Pagination token for the previous page. |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | An array of Action 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 |
|---|---|---|
| accountId | string | Owning account ID. |
| cloudId | string | Owning device cloud ID. |
| context | object | Alert context. |
| count | number | Count of alerts for this sequence. |
| id | string | Unique alert ID. |
| message | string | Text message regarding alert. |
| name | string | Action name generating the alert. |
| seq | string | Unique sequence string for the alert type. |
| severity | string | Alert severity. |
| subject | string | Alert subject. |
| resolved | boolean | Set to true when alert is resolved. |
| timestamp | date | When the alert was created. |
Get
Get a matching alert for a cloud.
Endpoint
HTTP
POST /alert/getAuthorized User Role
adminRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Alert ID. |
Response
Object Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| cloudId | string | Owning device cloud ID. |
| context | object | Alert context. |
| count | number | Count of alerts for this sequence. |
| id | string | Unique alert ID. |
| message | string | Text message regarding alert. |
| name | string | Action name generating the alert. |
| seq | string | Unique sequence string for the alert type. |
| severity | string | Alert severity. |
| subject | string | Alert subject. |
| resolved | boolean | Set to true when alert is resolved. |
| timestamp | date | When the alert was created. |
Remove
Remove an alert.
Endpoint
HTTP
POST /alert/removeAuthorized User Role
adminRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Alert ID. |
Update
Update an alert.
Endpoint
HTTP
POST /alert/updateAuthorized User Role
adminRequest Body
| Field | Type | Notes |
|---|---|---|
| id | string | Alert ID. |
| resolved | boolean | Resolved status. |
Response
Object Record.
| Field | Type | Notes |
|---|---|---|
| accountId | string | Owning account ID. |
| cloudId | string | Owning device cloud ID. |
| context | object | Alert context. |
| count | number | Count of alerts for this sequence. |
| id | string | Unique alert ID. |
| message | string | Text message regarding alert. |
| name | string | Action name generating the alert. |
| seq | string | Unique sequence string for the alert type. |
| severity | string | Alert severity. |
| subject | string | Alert subject. |
| resolved | boolean | Set to true when alert is resolved. |
| timestamp | date | When the alert was created. |