Skip to content

Alert

Manage Alerts.


Find

Endpoint

1
POST /alert/find

Authorized User Role

1
user

Query String Options

Field Type Notes
filter string Full text string to filter for.
next object Pagination token for the next page.
prev object Pagination token for the previous page.
limit number Number of items to retrieve.
index string Database index to use.
exists boolean Set to true to require the item exists, otherwise set to null to perform an upsert.

Response

Paged response.

Field Type Notes
data array Array of items.
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

An array of Alert items.

Field Type Notes
seq string
accountId string
context object
cloudId string Owning device cloud ID.
count number
id string Unique alert ID.
name string
message string
severity string
subject string
resolved boolean
timestamp date

Get

Endpoint

1
POST /alert/get

Authorized User Role

1
admin

Request Body

Field Type
id string

Response

Field Type Notes
seq string
accountId string
context object
cloudId string Owning device cloud ID.
count number
id string Unique alert ID.
name string
message string
severity string
subject string
resolved boolean
timestamp date