Alarm Actions API


This API will be used to execute alarm actions like Assigning, Unassigning, Clearing Alarms and Adding, Listing Annotations in Applications Manager.

API for XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/AlarmAction?apikey=<api_key>&action=<action_type>&entity=<alarm_entity>&username=<user name>&message=<message>

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/AlarmAction?apikey=<api_key>&action=<action_type>&entity=<alarm_entity>&username=<user name>&message=<message>

Request Parameters:

FieldDescription
AppManager_Host The server in which Applications Manager is installed.
AppManager_Port The Applications Manager webserver port.
api_key The API key of the user performing the operation.
action_type PickupAlarm / UnpickupAlarm / ClearAlarm / AddAnnotation / ListAnnotations
entity The entity field should have value [Resource ID of Monitor]_[Attribute ID]. This is a unique identifier for an alarm in Applications Manager.
message Specify the message used to annotate an alarm.
username Username used to pickup the alarm on the absence of which, the, username of the apikey will be used.

Sample XML Input:

http://apm-prod1:9090/AppManager/xml/AlarmAction?apikey=37097301e45784daa94889f35f2509ab&action=ClearAlarm&entity=10000285_527

Sample XML Response:

<AppManager-response uri="/AppManager/xml/AlarmAction"><result><response response-code="4000"><message>Successfully Cleared the Alarm!</message></response></result></AppManager-response>

JSON Input

http://apm-prod1:9090/AppManager/json/AlarmAction?apikey=37097301e45784daa94889f35f2509ab&action=ClearAlarm&entity=10000285_527

JSON Response

{"response":{"result":[{"message":"Successfully Cleared the Alarm!"}],"uri":"/AppManager/json/AlarmAction"},"response-code":"4000"}