Get a Device by ID
get
/api/device/Devices/{id}
Gets the device that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The device ID.Example:
1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : deviceDevicesRead
Type:
Show Source
object
-
CustomName: string
The custom name.Example:
Custom Nice Name
-
DeviceGroupName: string
The device group name.Example:
root
-
DeviceID: integer
The device ID.Example:
1
-
DeviceName: string
The device name. This is created automatically in order of precedence based on CustomName, DNSName, SysName, IPv6Address, and IPAddress.Example:
router.example.com
-
DevicePriorityID: integer
The device priority ID.Example:
1
-
DeviceSNMPAccessID: integer
SNMP Access Profile IDExample:
1
-
DeviceStateID: integer
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)
Example:1
-
DeviceStatus: string
The device status.Example:
new
-
DeviceStatusIcon: string
Colour value for DeviceStatusID. Possible values: - 0 (New) => 'red' - 1 (Non-discoverable) => 'purple' - 2 (Verified) => 'yellow' - 3 (Discovered) => 'green' - 101 (Static) => 'gray' - 102 (Virtual) => 'blue'Example:
green
-
DeviceTypeCategoryDiscoveredID: integer
The automatically discovered device type category ID.Example:
1
-
DeviceTypeCategoryDiscoveredName: string
The automatically discovered device type category name.Example:
Router
-
DeviceTypeCategoryID: integer
The manually set device type category ID.Example:
1
-
DeviceTypeName: string
The manually set device type category name.Example:
Router
-
DeviceZoneID: integer
The device zone ID.Example:
1
-
DeviceZoneName: string
The device zone name.Example:
Default First Zone
-
DNSName: string
DNS NameExample:
router1.example.com
-
FirstFound: string
The timestamp when the device was first discovered, in YYYY-MM-DD HH:MM:SS format.Example:
2006-01-02 15:04:05
-
GeoLocation: string
The GeoJSON point of device location (lon, lat).Example:
{"type": "Point", "coordinates": [0, 0]}
-
IPv4: string
The IPv4 address.Example:
192.0.2.1
-
IPv6: string
The IPv6 address in hex notation.Example:
2001:DB8::1
-
LastFound: string
The timestamp when the device was last discovered, in YYYY-MM-DD HH:MM:SS format.Example:
2006-01-02 15:04:05
-
LastModified: string
The timestamp when the device was last modified, in YYYY-MM-DD HH:MM:SS format.Example:
2006-01-02 15:04:05
-
ParentDeviceID: integer
The parent device ID for virtual devices.Example:
0
-
SerialNumber: string
Serial NumberExample:
-
ShardID: integer
The device shard ID.Example:
1
-
SysContact: string
SNMP System ContactExample:
-
SysDescription: string
SNMP System DescriptionExample:
-
SysLocation: string
SNMP System LocationExample:
-
SysName: string
SNMP System NameExample:
EXAMPLE-ROUTER
-
SysOID: string
SNMP System Object IDExample:
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