Create a Metric Threshold
post
/api/metric/Thresholds
Creates a metric threshold.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AbnormalProfileID: integer
Abnormal Profile ID used by Abnormal Thresholds only Allowed Values: - 0 => NoneExample:
0
-
CriticalOperator: string
Operator Allowed Values: - == - != - < - > - <= ->==>Example:
==
-
CriticalSeverity: string
Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = CriticalExample:
5
-
CriticalValue: number
Value to test forExample:
0
-
ForecastTimeRange: string
(Trend Prediction Only) Relative time from now in a friendly text formatExample:
-
Frequency: string
If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", how often the threshold is being checked. This should not be less than the PollTime. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for daysExample:
5m
-
Measurement: string
String representing a metric stored in influxExample:
metrictype_Latency
-
Message: string
Threshold MessageExample:
Performance threshold violation: Device Down
-
MetricField: string
String of metric being collectedExample:
availability
-
Offset: string
If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", what offset to apply to the time range, e.g "Go back 5 minutes when checking the threshold to ensure most recent poll data is considered". 0 minutes means no offset. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for daysExample:
0m
-
StatusID: boolean
Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ThresholdFunctionID: integer
Threshold Function IDExample:
1
-
ThresholdName: string
Threshold NameExample:
Device Down
-
ThresholdTypeID: integer
Allowed Values: - 1 => Availability - Standard - 2 => Performance Utilization - Standard - 3 => Performance Value - Standard - 10 => Trend % Daily - Advanced - 14 => Abnormal Daily - Advanced - 16 => Missing Data - Advanced - 20 => Trend Prediction Availability - Advanced - 21 => Trend Prediction Performance Utilization - Advanced - 22 => Trend Prediction Performance Value - AdvancedExample:
1
-
TimeRange: string
Unless Type is set to "Abnormal", the period of time where data points will be retrieved and evaluated. This must be a combination of a numerical value and a duration, which must be set to one of the following:- - s for seconds - m for minutes - h for hours - d for daysExample:
15m
-
WarningOperator: string
Warning OperatorExample:
-
WarningSeverity: string
Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = CriticalExample:
3
-
WarningValue: number
Value to test forExample:
0
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The new metric threshold.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricThresholdsRead
Type:
Show Source
object
-
AbnormalProfileID: integer
Abnormal Profile ID used by Abnormal Thresholds only Allowed Values: - 0 => NoneExample:
0
-
AbnormalProfileName: string
Abnormal Profile NameExample:
None
-
CheckLocation: integer
Location of threshold checking (Standard only) Allowed Values: - 1 => Threshold Engine - 2 => ApplicationExample:
1
-
CheckLocationName: string
Check Location NameExample:
Threshold Engine
-
CriticalOperator: string
Operator Allowed Values: - == - != - < - > - <= ->==>Example:
==
-
CriticalSeverity: integer
Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = CriticalExample:
5
-
CriticalValue: number
Value to test forExample:
0
-
ForecastTimeRange: string
(Trend Prediction Only) Relative time from now in a friendly text formatExample:
-
Frequency: string
If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", how often the threshold is being checked. This should not be less than the PollTime. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for daysExample:
5m
-
Measurement: string
String representing a metric stored in influxExample:
metrictype_Latency
-
Message: string
Threshold MessageExample:
Performance threshold violation: Device Down
-
MetricField: string
String of metric being collectedExample:
availability
-
MetricTypeName: string
Metric Type NameExample:
Latency
-
Offset: string
If Type is set to "Standard" and CheckLocation is set to "Threshold Engine", what offset to apply to the time range, e.g "Go back 5 minutes when checking the threshold to ensure most recent poll data is considered". 0 minutes means no offset. It must be a combination of a numerical value and a duration, which must be set to one of the following: - s for seconds - m for minutes - h for hours - d for daysExample:
0m
-
Status: string
StatusExample:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: boolean
Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ThresholdFunctionID: integer
Threshold Function IDExample:
1
-
ThresholdFunctionName: string
Threshold Function NameExample:
Mean
-
ThresholdID: integer
Threshold IDExample:
1
-
ThresholdName: string
Threshold NameExample:
Device Down
-
ThresholdTypeID: integer
Allowed Values: - 1 => Availability - Standard - 2 => Performance Utilization - Standard - 3 => Performance Value - Standard - 10 => Trend % Daily - Advanced - 14 => Abnormal Daily - Advanced - 16 => Missing Data - Advanced - 20 => Trend Prediction Availability - Advanced - 21 => Trend Prediction Performance Utilization - Advanced - 22 => Trend Prediction Performance Value - AdvancedExample:
1
-
ThresholdTypeName: string
Threshold Type NameExample:
Standard
-
TimeRange: string
Unless Type is set to "Abnormal", the period of time where data points will be retrieved and evaluated. This must be a combination of a numerical value and a duration, which must be set to one of the following:- - s for seconds - m for minutes - h for hours - d for daysExample:
15m
-
WarningOperator: string
Warning OperatorExample:
-
WarningSeverity: integer
Severity Allowed Values: - 0 = Normal - 1 = Info - 2 = Unknown - 3 = Minor - 4 = Major - 5 = CriticalExample:
3
-
WarningValue: number
Value to test forExample:
0
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object