Schedule demo

Configure Alarms APIs


These APIs allow an admin user to configure alarms in Applications Manager. This API can also be used to configure alarms for monitor types.

Syntax

  • https://[HOST]:[PORT]/AppManager/xml/configurealarms?apikey=[ API Key ]&resourceid=[resourceid of monitor]&attributeid=[attribute IDs]&thresholdid=[Threshold ID]&criticalactionid=[Action ID]&warningactionid=[Action ID]&clearactionid=[Action ID]&requesttype=[1/2]&availabilityCriticalPollCount=[count]&availabilityClearPollCount=[count]
  • https://[HOST]:[PORT]/AppManager/xml/configurealarms?apikey=[API Key]&resourceType=[ Resource Type]&thresholdid=[Threshold ID]&attributeid=[attribute IDs]&requesttype=[1/2]&overrideConf=[true/false]

Supported HTTP methods: POST

Allowed roles: Administrator

Request Parameters

The parameters involved in executing this API request are:

FieldDescription
apikeyThe key generated using the Generate API Key option in the Settings tab.
resourceid/monitornameThe resource ID/name of the monitor.
attributeidThe attribute ID of the alarm attribute to be configured.
thresholdid/thresholdnameThe ID or name of the threshold which will be assigned to attribute to configure alarm.
criticalactionid/criticalactionnameThe ID or name of action to notify critical condition of the attribute .
warningactionid/warningactionnameThe ID or name of action to notify warning condition of the attribute.
clearactionid/clearactionnameThe ID or name of action to notify clear condition of the attribute.
availabilityCriticalPollCount / availabilityClearPollCount The polls to retry count for critical/ clear status.
requesttypeThis attribute specifies if you wish to Save the Configuration, Save And Configure Another Alarm or Remove Configuration. Possible values are:
  • 1 - Save
  • 2 - Save And Configure Another
  • 3 - Remove Configuration
  • 8 - Delete the template, disassociate the threshold and actions from monitors
overrideConfSpecify if you want to override existing Threshold Configuration. Possible values are:  true/false
resourceTypeThe monitor type to which the alarm template should be applied.
haidMonitor group ID in which the alarm has to configured.
removeRCAIndicates whether the RCA message needs to be removed in the alarm. Value should be true/false or can be left empty.
similarmonitorsCommon separate resource ID of the monitor of same type.
resIDsToNotApplyTemplateResource IDs of the monitor which are not to applied from the Central Server.
multimonitorsWhen apply to similar monitor is enabled [Deprected but can be added via global config key]
overrideConfig\overrideConfWhen a threshold is associated via a template and has to override the configuration done at monitor level.
deleteConfigTypeWhen a threshold is associated via a template and has to delete the template.
displaynameDisplay name of the threshold.
typeIndicates the threshold type. Possible values are:
  • 1,2 - Integer
  • 3 - Float
  • 4 - String
descriptionDescription of the created threshold profile.
newthresholdidIndicates the threshold ID.
criticalthresholdvalueValue to compare for critical alert using moving average values of 7,10,30 days or 1,6,10 hours.
warningthresholdvalueValue to compare for warning alert using moving average values of 7,10,30 days or 1,6,10 hours
infothresholdvalueValue to compare for clear alert using moving average values of 7,10,30 days or 1,6,10 hours
criticalthresholdconditionCondition to compare Critical threshold value and value got from data collection.
warningthresholdconditionCondition to compare Warning threshold value and value got from data collection.
infothresholdconditionCondition to compare Clear threshold value and value got from data collection.
consecutive_criticalpollsThis is to configure consecutive polls at threshold level for Critical severity.
consecutive_warningpollsThis is to configure consecutive polls at threshold level for Warning severity.
consecutive_clearpollsThis is to configure consecutive polls at threshold level for Clear severity.
criticalthresholdmessageMessage description for Critical severity.
warningthresholdmessageMessage description for Warning severity.
infothresholdmessageMessage description for Clear severity.
adminAPIRequestIn 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_selectedTo apply the configured threshold to similar monitor of its type.
groupTemplateThis 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

Sample Request

  • https://apm-prod-server:8443/AppManager/xml/configurealarms?apikey=aaaaaabbbbbbccccccddddddeeeeee&resourceid=10000111&thresholdid=3&attributeid=400,401,53007&requesttype=1&criticalactionid=10000003&overrideConf=true&availabilityCriticalPollCount=4&availabilityClearPollCount=7
  • https://apm-prod-server:8443/AppManager/xml/configurealarms?apikey=aaaaaabbbbbbccccccddddddeeeeee&resourceType=PHP&thresholdid=3&attributeid=2304&requesttype=1&overrideConf=false

Loved by customers all over the world

"Standout Tool With Extensive Monitoring Capabilities"

It allows us to track crucial metrics such as response times, resource utilization, error rates, and transaction performance. The real-time monitoring alerts promptly notify us of any issues or anomalies, enabling us to take immediate action.

Reviewer Role: Research and Development

carlos-rivero
"I like Applications Manager because it helps us to detect issues present in our servers and SQL databases."
Carlos Rivero

Tech Support Manager, Lexmark

Trusted by over 6000+ businesses globally