Threshold Configuration APIs

These APIs allow an admin user to configure thresholds in Applications Manager. Threshold Configuration APIs are designed to support GET and POST requests:

Add Threshold (POST Method)
Update Threshold (POST Method)
Delete Threshold (POST Method)
List Threshold (GET Method)

Request Parameters

The parameters involved in executing this API request are:

Field	Description
thresholdname	The threshold display name. If the display name of threshold / action contains a special character like # , & or + : # should be replaced with %23 & should be repalced with %26 + should be replaced with %2B while passing the thresholdname in the RESTAPI.
criticalcondition, warningcondition, clearcondition	Possible Values for conditions are: Numeric and Float Threshold conditions: LT - Lesser than httpValue GT - Greater than httpValue EQ - Equal to httpValue NE - Not equal to httpValue LE - Lesser than or Equal to GE - Greater than or Equal to String Threshold Condition: CT - Contains DC - Does not contain QL - Equal to NQ - Not equal to SW - Starts with EW - Ends with
criticalvalue, clearvalue, warningvalue	Values for critical, clearvalue or warning state.
criticalpolls, warningpolls, clearpolls	Value denoting critical, clearvalue or warning polls.
warningmessage, clearmessage, criticalmessage	Message to notify the user of a warning, critical or clear condition.
Type	The type of threshold. Possible values are: 1 for Numeric Threshold 4 for Float Threshold 3 for String Threshold

Add Threshold

This API allows an admin user to add thresholds in Applications Manager.

Syntax:

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&clearvalue=[ Clear Value ]&criticalpolls=[ Critical Polls ]&clearcondition=[ Clear Condition ]&criticalmessage=[ Critical Message ]&thresholdname=[ Threshold name ]&clearmessage= [Clear Message ]&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=Warning Message&warningpolls=[ Warning Polls ]&clearpolls=[ Clear polls ]&warningvalue=[ Warning Value ]&criticalvalue=[ Critical Value ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&clearvalue=[ Clear Value ]&criticalpolls=[ Critical Polls ]&clearcondition=[ Clear Condition ]&criticalmessage=[ Critical Message ]&thresholdname=[ Threshold name ]&clearmessage= [Clear Message ]&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=Warning Message&warningpolls=[ Warning Polls ]&clearpolls=[ Clear polls ]&warningvalue=[ Warning Value ]&criticalvalue=[ Critical Value ]

Example

http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&clearvalue=5&criticalpolls=3&clearcondition=EQ&criticalmessage=Critical message&thresholdname=Sample Threshold&clearmessage=Clear Message&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=Warning Message&warningpolls=3&clearpolls=3&warningvalue=15&criticalvalue=5

Update Threshold Hour

This API allows an admin user to edit the thresholds added in Applications Manager.

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&clearvalue=[ Clear Value ]&criticalpolls=[ Critical Polls ]&clearcondition=[ Clear Condition ]&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=[ Warning Polls ]&thresholdid=[ Threshold Id ] &warningvalue=[ Warning Value&criticalvalue=[ Critical Value]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&clearvalue=[ Clear Value ]&criticalpolls=[ Critical Polls ]&clearcondition=[ Clear Condition ]&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=[ Warning Polls ]&thresholdid=[ Threshold Id ] &warningvalue=[ Warning Value&criticalvalue=[ Critical Value]

Example

http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&clearvalue=5&criticalpolls=0&clearcondition=GT&criticalmessage=updated message&clearmessage=&type=1&criticalcondition=GT&warningcondition=GT&warningmessage=&warningpolls=0&description=&newthresholdname=Sample Threshold&clearpolls=0&thresholdid=10001&warningvalue=5&criticalvalue=5

Delete Threshold

This API allows an admin user to delete thresholds in Applications Manager.

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]&thresholdid=[ Threshold Id=],&TO_DELETE=true

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]&thresholdid=[ Threshold Id=],&TO_DELETE=true

Example

http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1&thresholdid=10001,10003,10002,10000,&TO_DELETE=true

List Thresholds

This API allows an admin user to list down the thresholds in Applications Manager.

Syntax

For XML Response:

http://[ APM Host ]:[ APM Port ]/AppManager/xml/threshold?apikey=[ API Key ]

For JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/threshold?apikey=[ API Key ]

Example

http://app-windows:59090/AppManager/xml/threshold?apikey=09eebdd6893db4d20e16b84dff6664f1

Top

<< Prev	Home	Next >>
Mail Server Configuration		Error Handling