Update a Metric
put
/api/metric/Metrics/{id}
Updates the properties of the specified metric.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the metric to update.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CustomMaximum: number
Metric Custom Maximum to override auto maximum
-
DeviceName: string
Device Name. The name will be CustomName, DNSName, SysName, IPv6Address, or IPAddress. Whichever value is found first is used.Example:
device.example.com
-
DeviceZoneName: string
The zone the device is assigned to.Example:
Default First Zone
-
Factor: integer
FactorExample:
1
-
InstanceID: integer
ID of Instance from Assure1.metricInstancesExample:
0
-
Maximum: integer
MaximumExample:
100
-
MethodID: integer
ID from Assure1.MetricMethodsExample:
0
-
MetricTypeID: integer
ID of Metric Type from Assure1.MetricTypesExample:
63
-
PollTime: integer
Metric collection interval (used for display only)Example:
300
-
ShardID: integer
ID of the shard the metric resides onExample:
1
-
StatusID: integer
Metric Status | Allowed Values: | 0 => Disabled | 1 => EnabledExample:
1
-
Thresholds: array
Thresholds
collection of assigned thresholds
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulUpdateOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Updated 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
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricMetricsPut
Type:
Show Source
object
-
CustomMaximum: number
Metric Custom Maximum to override auto maximum
-
DeviceID: integer
ID of Device from Assure1.DevicesExample:
1599
-
Factor: integer
FactorExample:
1
-
InstanceID: integer
ID of Instance from Assure1.metricInstancesExample:
0
-
Maximum: integer
MaximumExample:
100
-
MethodID: integer
ID from Assure1.MetricMethodsExample:
0
-
MetricTypeID: integer
ID of Metric Type from Assure1.MetricTypesExample:
63
-
PollTime: integer
Metric collection interval (used for display only)Example:
300
-
ShardID: integer
ID of the shard the metric resides onExample:
1
-
StateID: integer
Metric Status | Allowed Values: | 0 => Disabled | 1 => EnabledExample:
1
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