These APIs allow an admin user to configure alarms in Applications Manager. This API can also be used to configure alarms for monitor types.
Supported HTTP methods: POST
Allowed roles: Administrator
The parameters involved in executing this API request are:
| Field | Description |
|---|---|
| apikey | The key generated using the Generate API Key option in the Settings tab. |
| resourceid/monitorname | The resource ID/name of the monitor. |
| attributeid | The attribute ID of the alarm attribute to be configured. |
| thresholdid/thresholdname | The ID or name of the threshold which will be assigned to attribute to configure alarm. |
| criticalactionid/criticalactionname | The ID or name of action to notify critical condition of the attribute . |
| warningactionid/warningactionname | The ID or name of action to notify warning condition of the attribute. |
| clearactionid/clearactionname | The ID or name of action to notify clear condition of the attribute. |
| availabilityCriticalPollCount / availabilityClearPollCount | The polls to retry count for critical/ clear status. |
| requesttype | This attribute specifies if you wish to Save the Configuration, Save And Configure Another Alarm or Remove Configuration. Possible values are:
|
| overrideConf | Specify if you want to override existing Threshold Configuration. Possible values are: true/false |
| resourceType | The monitor type to which the alarm template should be applied. |
| haid | Monitor group ID in which the alarm has to configured. |
| removeRCA | Indicates whether the RCA message needs to be removed in the alarm. Value should be true/false or can be left empty. |
| similarmonitors | Common separate resource ID of the monitor of same type. |
| resIDsToNotApplyTemplate | Resource IDs of the monitor which are not to applied from the Central Server. |
| multimonitors | When apply to similar monitor is enabled [Deprected but can be added via global config key] |
| overrideConfig\overrideConf | When a threshold is associated via a template and has to override the configuration done at monitor level. |
| deleteConfigType | When a threshold is associated via a template and has to delete the template. |
| displayname | Display name of the threshold. |
| type | Indicates the threshold type. Possible values are:
|
| description | Description of the created threshold profile. |
| newthresholdid | Indicates the threshold ID. |
| criticalthresholdvalue | Value to compare for critical alert using moving average values of 7,10,30 days or 1,6,10 hours. |
| warningthresholdvalue | Value to compare for warning alert using moving average values of 7,10,30 days or 1,6,10 hours |
| infothresholdvalue | Value to compare for clear alert using moving average values of 7,10,30 days or 1,6,10 hours |
| criticalthresholdcondition | Condition to compare Critical threshold value and value got from data collection. |
| warningthresholdcondition | Condition to compare Warning threshold value and value got from data collection. |
| infothresholdcondition | Condition to compare Clear threshold value and value got from data collection. |
| consecutive_criticalpolls | This is to configure consecutive polls at threshold level for Critical severity. |
| consecutive_warningpolls | This is to configure consecutive polls at threshold level for Warning severity. |
| consecutive_clearpolls | This is to configure consecutive polls at threshold level for Clear severity. |
| criticalthresholdmessage | Message description for Critical severity. |
| warningthresholdmessage | Message description for Warning severity. |
| infothresholdmessage | Message description for Clear severity. |
| adminAPIRequest | In Enterprise Edition, when a threshold is configured for a Probe Server monitor it would sent this param to say it is from Central Server. |
| similarmonitors_selected | To apply the configured threshold to similar monitor of its type. |
| groupTemplate | This param has to be set as True, if we need to make API for Group Template. |
Note: To configure alarm for more than one attribute, specify attributes by comma separation. e.g: 402,412,413
Thank you for your feedback!
