HomeGuidesAPI Reference
API Reference

Update alarm correlation settings

Updates alarm correlation and remote notification settings. When correlation status changes, aggregation settings are synchronized and changes are orchestrated to all appliances. Validation rules: remoteNotificationType 'correlated' or 'both' requires correlationEnabled=true.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Alarm correlation settings. Both fields are required.

Configuration for alarm correlation and remote notification behavior.

boolean
required
Defaults to false

Enables alarm correlation feature to group related alarms. When changed, triggers orchestration to all appliances.

string
enum
required
Defaults to correlated

Notification type for remote systems. 'standard' sends individual alarms, 'correlated' sends grouped alarms, 'both' sends both. Must be 'standard' if correlation is disabled.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized. Invalid or missing authentication credentials.

403

Forbidden. Requires READ_WRITE role.

500

Internal server error saving configuration to database.

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