Update a Metric Instance
put
/api/metric/Instances/{id}
Updates the metric instance that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The ID of the metric instance to update.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DeviceName: string
Device NameExample:
router.example.com
-
DeviceZoneName: string
Device Zone NameExample:
Default First Zone
-
InstanceTypeID: integer
Instance Type IDExample:
2
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 : metricInstancesRead
Type:
Show Source
object
-
DeviceID: integer
Device IDExample:
1281
-
DeviceName: string
Device NameExample:
router.example.com
-
DeviceZoneName: string
Device Zone NameExample:
Default First Zone
-
InstanceID: integer
Instance IDExample:
235035
-
InstanceName: string
Instance NameExample:
Example_Instance
-
InstanceType: string
Instance TypeExample:
SNMP Custom
-
InstanceTypeID: integer
Instance Type IDExample:
2
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