Create or update alarm email notification configurations

post

http://127.0.0.1:8080/alarm/alarmConfig

Creates or updates alarm email notification configurations. Validates each configuration object and saves the complete list, replacing any existing configurations. Logs the action in the system action log. Requires READ_WRITE permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Array of alarm configuration objects to save. This operation replaces ALL existing configurations with the provided array. Each configuration is validated before saving.

Array of alarm configuration objects. This replaces all existing configurations.

Alarm email notification configuration object. Defines which alarms trigger email notifications and to whom they are sent.

configurationName

string

required

length ≥ 1

Unique identifier name for this notification rule. Cannot be empty or null.

alarmType

string

enum

required

Alarm source filter. GMS=Orchestrator alarms only, Appliance=Edge device alarms only (requires applianceGroups), RCA=Root Cause Analysis alarms, Both=GMS and Appliance alarms.

Allowed:

critical

boolean

Defaults to false

Include critical severity alarms in notifications. At least one severity (critical, major, minor, warning) must be true.

major

boolean

Defaults to false

Include major severity alarms in notifications. At least one severity (critical, major, minor, warning) must be true.

minor

boolean

Defaults to false

Include minor severity alarms in notifications. At least one severity (critical, major, minor, warning) must be true.

warning

boolean

Defaults to false

Include warning severity alarms in notifications. At least one severity (critical, major, minor, warning) must be true.

emailAddresses

string

required

length ≥ 1

Comma-separated list of email recipients. Cannot be empty or null. Semicolons are automatically converted to commas.

format

string

enum

Defaults to HTML Formatted

Email body format for notifications. Determines how alarm information is formatted in the email.

Allowed:

applianceGroups

array of strings

Array of appliance group IDs to filter alarms. Required and must contain at least one element when alarmType is 'Appliance'. Ignored for other alarmType values.

applianceGroups

debugOn

boolean

Defaults to false

Enable debug logging for this configuration. When true, additional diagnostic information is logged during notification processing.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Alarm configuration created or updated successfully. Replaces all existing configurations with the provided array.

400Validation failed. Request body is invalid or missing required fields.