Update a Device
put
/api/device/Devices/{id}
Updates the properties of the device that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The device ID.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CustomName: string
The device custom name.
-
DevicePriorityID: integer
The device priority ID.
-
DeviceSNMPAccessID: integer
The SNMP access profile ID.
-
DeviceStateID: integer
Allowed Values:
[ 0, 1, 2, 3, 101, 102 ]
The device state ID. Valid values are:- >0: New
- 1: Non-discoverable
- 2: Verified (Discovered)
- 3: Discovered (Fully)
- 101: Static (Disabled)
- 102: Virtual (Non-device)
-
DeviceTypeCategoryID: integer
The device type category ID.
-
DeviceZoneID: integer
The device zone ID.
-
DNSName: string
The device DNS name.
-
GeoLocation: string
The GeoJSON point of device location (lon, lat).
-
InitialDeviceGroupID: integer
The initial device group ID.
-
IPv4: string
The IPv4 address.
-
IPv6: string
The IPv6 address in hex notation.
-
MetaData: array
MetaData
The metadata object definitions for the device (DeviceMetaTypeID, MetaData).
-
ParentDeviceID: integer
The parent device ID for virtual devices.
-
ShardID: integer
The device shard ID. If database sharding is not configured, it defaults to 1.
Nested Schema : MetaData
Type:
array
The metadata object definitions for the device (DeviceMetaTypeID, MetaData).
Show Source
Nested Schema : items
Type:
object
Response
200 Response
Successful operation
Root 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
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