Jump to

• Request
• Response

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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The device properties.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/deviceDevicesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The device properties.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The device properties.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceDevicesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The device properties.

Show Source

• Array of: object deviceDevicesRead

{
    "description":"The device properties.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceDevicesRead"
    }
}

Nested Schema : deviceDevicesRead

Type: object

Show Source

• CustomName: string
  The custom name.

  Example: My Custom Device
• 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
  The SNMP access profile ID.

  Example: 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
  The colour value for DeviceStatusID. The possible values are:

  • 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
  The DNS name.

  Example: 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
  The serial number.

  Example:
• ShardID: integer
  The device shard ID.

  Example: 1
• SysContact: string
  The SNMP system contact.

  Example:
• SysDescription: string
  The SNMP system description.

  Example:
• SysLocation: string
  The SNMP system location.

  Example:
• SysName: string
  The SNMP system name.

  Example: EXAMPLE-ROUTER
• SysOID: string
  The SNMP system object ID.

  Example:

{
    "properties":{
        "DeviceID":{
            "description":"The device ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceName":{
            "description":"The device name. This is created automatically in order of precedence based on CustomName, DNSName, SysName, IPv6Address, and IPAddress.",
            "type":"string",
            "example":"router.example.com"
        },
        "IPv4":{
            "description":"The IPv4 address.",
            "type":"string",
            "example":"192.0.2.1"
        },
        "IPv6":{
            "description":"The IPv6 address in hex notation.",
            "type":"string",
            "example":"2001:DB8::1"
        },
        "FirstFound":{
            "description":"The timestamp when the device was first discovered, in YYYY-MM-DD HH:MM:SS format.",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "LastModified":{
            "description":"The timestamp when the device was last modified, in YYYY-MM-DD HH:MM:SS format.",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "LastFound":{
            "description":"The timestamp when the device was last discovered, in YYYY-MM-DD HH:MM:SS format.",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "DevicePriorityID":{
            "description":"The device priority ID.",
            "type":"integer",
            "example":"1"
        },
        "ParentDeviceID":{
            "description":"The parent device ID for virtual devices.",
            "type":"integer",
            "example":"0"
        },
        "DeviceTypeCategoryID":{
            "description":"The manually set device type category ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceTypeName":{
            "description":"The manually set device type category name.",
            "type":"string",
            "example":"Router"
        },
        "DeviceTypeCategoryDiscoveredID":{
            "description":"The automatically discovered device type category ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceTypeCategoryDiscoveredName":{
            "description":"The automatically discovered device type category name.",
            "type":"string",
            "example":"Router"
        },
        "DeviceZoneID":{
            "description":"The device zone ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceStateID":{
            "description":"The device state ID. Valid values are:\n<ul>\n<li><b>0</b>: New</li>\n<li><b>1</b>: Non-discoverable</li>\n<li><b>2</b>: Verified (Discovered)</li>\n<li><b>3</b>: Discovered (Fully)</li>\n<li><b>101</b>: Static (Disabled)</li>\n<li><b>102</b>: Virtual (Non-device)</li>\n</ul>",
            "type":"integer",
            "example":"1"
        },
        "DeviceStatus":{
            "description":"The device status.",
            "type":"string",
            "example":"new"
        },
        "DeviceStatusIcon":{
            "description":"The colour value for <b>DeviceStatusID</b>. \nThe possible values are:\n<ul><li><b>0 (New)</b>: 'red'</li>\n<li><b>1 (Non-discoverable)</b>: 'purple'</li>\n<li><b>2 (Verified)</b>: 'yellow'</li>\n<li><b>3 (Discovered)</b>: 'green'</li>\n<li><b>101 (Static)</b>: 'gray'</li>\n<li><b>102 (Virtual)</b>: 'blue'</li></ul>",
            "type":"string",
            "example":"green"
        },
        "DNSName":{
            "description":"The DNS name.",
            "type":"string",
            "example":"router1.example.com"
        },
        "CustomName":{
            "description":"The custom name.",
            "type":"string",
            "example":"My Custom Device"
        },
        "DeviceZoneName":{
            "description":"The device zone name.",
            "type":"string",
            "example":"Default First Zone"
        },
        "ShardID":{
            "description":"The device shard ID.",
            "type":"integer",
            "example":"1"
        },
        "DeviceGroupName":{
            "description":"The device group name.",
            "type":"string",
            "example":"root"
        },
        "GeoLocation":{
            "description":"The GeoJSON point of device location (lon, lat).",
            "type":"string",
            "example":"{\"type\": \"Point\", \"coordinates\": [0, 0]}"
        },
        "DeviceSNMPAccessID":{
            "description":"The SNMP access profile ID.",
            "type":"integer",
            "example":"1"
        },
        "SysOID":{
            "description":"The SNMP system object ID.",
            "type":"string",
            "example":""
        },
        "SysName":{
            "description":"The SNMP system name.",
            "type":"string",
            "example":"EXAMPLE-ROUTER"
        },
        "SysLocation":{
            "description":"The SNMP system location.",
            "type":"string",
            "example":""
        },
        "SysContact":{
            "description":"The SNMP system contact.",
            "type":"string",
            "example":""
        },
        "SysDescription":{
            "description":"The SNMP system description.",
            "type":"string",
            "example":""
        },
        "SerialNumber":{
            "description":"The serial number.",
            "type":"string",
            "example":""
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top