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:
Supported HTTP methods: GET, POST
Allowed roles: Administrator, Operator, User
Request Parameters
The parameters involved in executing this API request are:
| Field | Description |
|---|
| thresholdname | The threshold display name. For display names that have special characters, replace '#' with %23, '&' with %26,'+' with%2Bwhile passing the threshold name in the RESTAPI. |
| criticalcondition, warningcondition, clearcondition, secondarycriticalthresholdcondition, secondarywarningthresholdcondition, secondaryinfothresholdcondition | 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
|
| criticalconditionjoiner, warningconditionjoiner, infoconditionjoiner | The joiner condition with which the two threshold conditions are evaluated. Possible values are:- OR - Logical "OR" condition
- AND - Logical "AND" condition
|
| criticalvalue, warningvalue, clearvalue, secondarycriticalthresholdvalue, secondarywarningthresholdvalue, secondaryinfothresholdvalue | Values for critical, warning or clear state. |
| criticalmessage, warningmessage, clearmessage | Message to notify the user of a critical, warning or clear condition. |
| criticalpolls, warningpolls, clearpolls | Values denoting the maximum number of consecutive polls for critical, warning or clear severity. |
| min_criticalpolls, min_warningpolls, min_clearpolls | Values denoting the minimum number of consecutive polls for critical, warning or clear severity. |
| type | The datatype of the threshold. Possible values are:- 1 for Numeric Threshold
- 4 for Float Threshold
- 3 for String Threshold
|
| thresholdType | The type of threshold to be configured. Possible values are:- 0 - Standard threshold
- 1 - Adaptive threshold
|
| adaptiveHigherPercentage | The values of the upper threshold limit in percentage (%). Possible values are:- 0 - Disable percentage checkbox
- 1 - Enable percentage checkbox
|
| adaptiveBaseformulaType | The formula type based on which the adaptive threshold is set. Possible values are:- 0 - Baseline
- 1 - Custom Expression
|
| adaptiveBaseWeek | The week based on which the baseline value is fixed in the adaptive threshold. Possible values are either "Previous Week" or the desired week in the "week-month-year" format. |
| businessHourAssociatedToThreshold | Option to enable business hour for threshold. Possible value: "enabled". |
| businessType | The business hour type based on which the threshold should be applied. Possible values are:- 0 - Outside selected business hours
- 1 - During selected business hours
|
| selectedBusinessHourID | Value denoting the Business Hour ID. The default value is '0'. |
| description | Description of the created threshold profile. |
| TO_DELETE | Indicates whether the threshold profile needs to be deleted. Value should only be true if threshold profile needs to be deleted. |
| secondarycriticalexist | Indicates whether to add an additional condition for Critical severity in the threshold profile. |
| secondarywarningexist | Indicates whether to add an additional condition for Warning severity in the threshold profile. |
| secondaryinfoexist | Indicates whether to add an additional condition for Clear severity in the threshold profile. |
| adaptiveType | Indicates whether the adaptive profile is Automatic or Manual. '0' is for Automatic and '1' is for Manual'. |
Create a Threshold
The following API allows an admin user to create thresholds in Applications Manager.
Syntax:
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=[ Threshold Type ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner=[ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=[ Threshold Type ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner=[ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ]
Example
https://apm-prod-server:8443/AppManager/xml/threshold?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=1&thresholdname=Sample Threshold&thresholdType=0&criticalcondition=GT&criticalvalue=10&criticalconditionjoiner=AND&secondarycriticalthresholdcondition=LT&secondarycriticalthresholdvalue=15&criticalmessage=criticalMessage&min_criticalpolls=2&criticalpolls=5&warningcondition=GT&warningvalue=5&warningconditionjoiner=AND&secondarywarningthresholdcondition=LT&secondarywarningthresholdvalue=10&warningmessage=warningMessage&min_warningpolls=2&warningpolls=5&clearcondition=GT&clearvalue=0&infoconditionjoiner=AND&secondaryinfothresholdcondition=LT&secondaryinfothresholdvalue=5&clearmessage=clearMessage&min_clearpolls=2&clearpolls=5&businessHourAssociatedToThreshold=enabled&businessType=1&selectedBusinessHourID=12345
Create an Adaptive Threshold
The following API allows an admin user to create adaptive thresholds in Applications Manager
Syntax:
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=1&adaptiveBaseformulaType=[ Adaptive Base Formula Type ]&adaptiveBaseWeek=[ Adaptive Base Week ]&adaptiveHigherPercentage=[ Adaptive Higher Percentage ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner=[ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ]&adaptiveType=[Adaptive Type]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/threshold?apikey=[ API Key ]&type=[ Type ]&thresholdname=[ Threshold Name ]&thresholdType=1&adaptiveBaseformulaType=[ Adaptive Base Formula Type ]&adaptiveBaseWeek=[ Adaptive Base Week ]&adaptiveHigherPercentage=[ Adaptive Higher Percentage ]&criticalcondition=[ Critical Condition ]&criticalvalue=[ Critical Value ]&criticalconditionjoiner=[ Critical Condition Joiner ]&secondarycriticalthresholdcondition=[ Secondary Critical Condition ]&secondarycriticalthresholdvalue=[ Secondary Critical Value ]&criticalmessage=[ Critical Message ]&min_criticalpolls=[ Minimum Critical Polls ]&criticalpolls=[ Maximum Critical Polls ]&warningcondition=[ Warning Condition ]&warningvalue=[ Warning Value ]&warningconditionjoiner=[ Warning Condition Joiner ]&secondarywarningthresholdcondition=[ Secondary Warning Condition ]&secondarywarningthresholdvalue=[ Secondary Warning Value ]&warningmessage=[ Warning Message ]&min_warningpolls=[ Minimum Warning Polls ]&warningpolls=[ Maximum Warning Polls ]&clearcondition=[ Clear Condition ]&clearvalue=[ Clear Value ]&infoconditionjoiner=[ Clear Condition Joiner ]&secondaryinfothresholdcondition=[ Secondary Clear Condition ]&secondaryinfothresholdvalue=[ Secondary Clear Value ]&clearmessage=[ Clear Message ]&min_clearpolls=[ Minimum Clear Polls ]&clearpolls=[ Maximum Clear Polls ]&adaptiveType=[Adaptive Type]
Example
https://apm-prod-server:8443/AppManager/xml/threshold?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=1&thresholdname=Sample Adaptive Threshold&thresholdType=1&adaptiveBaseformulaType=0&adaptiveBaseWeek=Previous Week&adaptiveHigherPercentage=1&criticalcondition=GT&criticalvalue=10&criticalconditionjoiner=AND&secondarycriticalthresholdcondition=LT&secondarycriticalthresholdvalue=15&criticalmessage=criticalMessage&min_criticalpolls=2&criticalpolls=5&warningcondition=GT&warningvalue=5&warningconditionjoiner=AND&secondarywarningthresholdcondition=LT&secondarywarningthresholdvalue=10&warningmessage=warningMessage&min_warningpolls=2&warningpolls=5&clearcondition=GT&clearvalue=0&infoconditionjoiner=AND&secondaryinfothresholdcondition=LT&secondaryinfothresholdvalue=5&clearmessage=clearMessage&min_clearpolls=2&clearpolls=5&adaptiveType=0
Update Threshold
The following API allows an admin user to edit the thresholds added in Applications Manager.
Syntax
For XML Response:
https://[HOST]:[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 ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ]&adaptiveType=[Adaptive Type]
For JSON Response:
https://[HOST]:[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 ]&businessHourAssociatedToThreshold=[ Associate Business Hour ]&businessType=[ Business Hour Type ]&selectedBusinessHourID=[ Business Hour ID ]&adaptiveType=[Adaptive Type]
Example
https://apm-prod-server:8443/AppManager/xml/threshold?apikey=aaaaaabbbbbbccccccddddddeeeeee&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&adaptiveType=0&businessHourAssociatedToThreshold=enabled&businessType=1&selectedBusinessHourID=12345
Delete Threshold
The following API allows an admin user to delete thresholds in Applications Manager.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/threshold?apikey=[ API Key ]&thresholdid=[ Threshold Id=],&TO_DELETE=true
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/threshold?apikey=[ API Key ]&thresholdid=[ Threshold Id=],&TO_DELETE=true
Example
https://apm-prod-server:8443/AppManager/xml/threshold?apikey=aaaaaabbbbbbccccccddddddeeeeee&thresholdid=10001,10003,10002,10000,&TO_DELETE=true
List Thresholds
The following API allows an admin user to list down the thresholds in Applications Manager.
Syntax
For XML Response:
https://[HOST]:[PORT]/AppManager/xml/threshold?apikey=[ API Key ]
For JSON Response:
https://[HOST]:[PORT]/AppManager/json/threshold?apikey=[ API Key ]
Example
https://apm-prod-server:8443/AppManager/xml/threshold?apikey=aaaaaabbbbbbccccccddddddeeeeee
Sample Response:
<AppManager-response uri="/AppManager/xml/threshold"><result><response response-code="4000"><Threshold CLEARPOLLSTORETRY="Use global defaults" CLEARTHRESHOLDCONDITION="<=" CLEARTHRESHOLDMESSAGE="The Health of the response time is good" CLEARTHRESHOLDVALUE="1500" CRITICALPOLLSTORETRY="Use global defaults" CRITICALTHRESHOLDCONDITION=">" CRITICALTHRESHOLDMESSAGE="The Health of the response time is bad" CRITICALTHRESHOLDVALUE="2000" DESCRIPTION="This is a preconfigured Threshold for Response Time" MINIMUMCLEARPOLLSTORETRY="Use global defaults" MINIMUMCRITICALPOLLSTORETRY="Use global defaults" MINIMUMWARNINGPOLLSTORETRY="Use global defaults" THRESHOLDID="3" THRESHOLDNAME="Response Time" WARNINGPOLLSTORETRY="Use global defaults" WARNINGTHRESHOLDCONDITION=">" WARNINGTHRESHOLDMESSAGE="The Health of the response time has generated a warning" WARNINGTHRESHOLDVALUE="1500"/><Threshold CLEARPOLLSTORETRY="Use global defaults" CLEARTHRESHOLDCONDITION="<=" CLEARTHRESHOLDMESSAGE="The Connection Time is good" CLEARTHRESHOLDVALUE="1500" CRITICALPOLLSTORETRY="Use global defaults" CRITICALTHRESHOLDCONDITION=">" CRITICALTHRESHOLDMESSAGE="The Connection Time is high" CRITICALTHRESHOLDVALUE="2000" DESCRIPTION="This is a preconfigured Threshold for Connection Time" MINIMUMCLEARPOLLSTORETRY="Use global defaults" MINIMUMCRITICALPOLLSTORETRY="Use global defaults" MINIMUMWARNINGPOLLSTORETRY="Use global defaults" THRESHOLDID="4" THRESHOLDNAME="Connection Time" WARNINGPOLLSTORETRY="Use global defaults" WARNINGTHRESHOLDCONDITION=">" WARNINGTHRESHOLDMESSAGE="The Connection Time has generated a warning" WARNINGTHRESHOLDVALUE="1500"/><Threshold CLEARPOLLSTORETRY="Use global defaults" CLEARTHRESHOLDCONDITION="<=" CLEARTHRESHOLDMESSAGE="The Request per minute is good" CLEARTHRESHOLDVALUE="120" CRITICALPOLLSTORETRY="Use global defaults" CRITICALTHRESHOLDCONDITION=">" CRITICALTHRESHOLDMESSAGE="The Request per minute is high" CRITICALTHRESHOLDVALUE="240" DESCRIPTION="This is a preconfigured Threshold for Request per minute" MINIMUMCLEARPOLLSTORETRY="Use global defaults" MINIMUMCRITICALPOLLSTORETRY="Use global defaults" MINIMUMWARNINGPOLLSTORETRY="Use global defaults" THRESHOLDID="5" THRESHOLDNAME="Request per minute" WARNINGPOLLSTORETRY="Use global defaults" WARNINGTHRESHOLDCONDITION=">" WARNINGTHRESHOLDMESSAGE="The Request per minute has generated a warning" WARNINGTHRESHOLDVALUE="120"/></response></result></AppManager-response>
