v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
Alert

Acknowledge the alerts

acknowledge the alerts by alert ids.

post/alerts/:acknowledge

Request body

alert_idsstring[] required

The alert ID list.

Response

OK

idstring required

The unique identifier

owner_idinteger

The owner ID

timestampstring date-time required

The alert create time

org_idinteger

The organization identifier, valid when enabling HIQ feature

message_metadata_idinteger

The message metadata id

message_metadata_typestring

The message metadata type

message_metadata_namestring

The message metadata name

summarystring

A high-level, text summary message of the event. Will be used to construct an alert's description.

severity_namestring

The severity name of the alert

category_namestring

The alert category name

severity_idinteger

The severity Id of the alert

category_idinteger

The alert category Id

acknowledgedboolean

The acknowledged status of alert

site_idinteger

The site id of alert

site_namestring

The site name of alert

alert_policy_idinteger

The policy id of alert

alert_policy_namestring

The policy name of alert

alert_rule_idinteger

The rule id of alert

acknowledged_usernamestring

The user's email who acknowledged

floor_idinteger

The floor id of alert

floor_namestring

The floor name of alert

building_idinteger

The buiding id of alert

building_namestring

The building name of alert