Alert

Manage Alerts.

Find

Endpoint

POST /alert/find

Authorized User Role

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

POST /alert/get

Authorized User Role

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

Remove

Endpoint

POST /alert/remove

Authorized User Role

admin

Request Body

Field	Type
id	string

Update

Endpoint

POST /alert/update

Authorized User Role

admin

Request Body

Field	Type
id	string
resolved	boolean

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