Create a new Device Alert by Template id

Create a new Device Alert by Template id

Request Body Parameters:

ParameterTypeMandatoryDescriptionExample
<customAttribute1><customAttribute1Type>falseRegular custom attribute 1 value
<customAttributeN><customAttributeNType>falseRegular custom attribute N value
_clearNotesstringfalseClear notes
_namestringfalseThe name of the alert
_severitystringfalseThe alert wanted severity Values:CRITICAL,MAJOR,MINOR,INFO Default:INFOMAJOR
_statestringfalseThe alert wanted state Values:ACTIVE,CLEARED,SUSPENDED Default:ACTIVEACTIVE
_templateIdstringtrueThe id of a template that is configured in the settings service.3fa85f64-5717-4562-b3fc-2c963f66afa6
Path Parameters:
ParameterTypeMandatoryDescriptionExample
deviceIdstringtruenull

This API requires PROTECTED_API permission(s).

Path Params
string
required
Body Params
string
enum
Defaults to ACTIVE

The alert wanted state

Allowed:
string
enum
Defaults to INFO

The alert wanted severity

Allowed:
string

Clear notes

string
length between 1 and 64

The name of the alert

uuid
required

The id of a template that is configured in the settings service.

Headers
string
enum
Defaults to async

X-Execution-Mode — Optional header to control execution mode.

Use sync to make the API wait until all background operations complete before returning a response.

If omitted, the request is processed asynchronously (default).

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json