Jump to

• Request
• Response

View all Devices

get

/api/device/Devices

Request

Query Parameters

• filter: object
  Filter results by most fields (note: Some fields contain state and cannot be filtered)
• limit: integer(int32)
  Number of records to limit results
• sort: object
  Sort results by field and direction (note: Some fields contain state and cannot be sorted)
• start: integer(int32)
  Page of results to start from

  Default Value: 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

Type: object

Show Source

• data: array data
  Record(s)
• message: string
  Response message in text

  Example: Loaded 1 entries
• success: boolean
  Success or failure response

  Example: true
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Loaded 1 entries"
        },
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"Record(s)",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/deviceDevicesRead"
            }
        }
    },
    "type":"object"
}

Nested Schema : data

Type: array

Record(s)

Show Source

• Array of: object deviceDevicesRead

{
    "description":"Record(s)",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/deviceDevicesRead"
    }
}

Nested Schema : deviceDevicesRead

Type: object

Show Source

• CustomName: string
  Custom Name

  Example: Custom Nice Name
• DeviceGroupName: string
  Device Group Name

  Example: root
• DeviceID: integer
  Device ID

  Example: 1
• DeviceName: string
  Device Name (auto created in order or precidence from CustomName > DNSName > SysName > IPv6Address > IPAddress)

  Example: router.example.com
• DevicePriorityID: integer
  Device Priority ID

  Example: 1
• DeviceSNMPAccessID: integer
  SNMP Access Profile ID

  Example: 1
• DeviceStateID: integer
  Device State ID

  Example: 1
• DeviceStatus: string
  Device Status

  Example: new
• DeviceStatusIcon: string
  Device Status icon color

  Example: green
• DeviceTypeCategoryDiscoveredID: integer
  Device Type Category ID (discovered automatically)

  Example: 1
• DeviceTypeCategoryDiscoveredName: string
  Device Type Category Name (discovered automatically)

  Example: Router
• DeviceTypeCategoryID: integer
  Device Type Category ID (set manually)

  Example: 1
• DeviceTypeName: string
  Device Type Category Name (set manually)

  Example: Router
• DeviceZoneID: integer
  Device Zone ID

  Example: 1
• DeviceZoneName: string
  Device Zone Name

  Example: Default First Zone
• DNSName: string
  DNS Name

  Example: router1.example.com
• FirstFound: string
  Timestamp when device was first discovered

  Example: 2006-01-02 15:04:05
• GeoLocation: string
  GeoJSON Point of device location (lon, lat)

  Example: {"type": "Point", "coordinates": [0, 0]}
• IPv4: string
  IP Address (v4)

  Example: 192.0.2.1
• IPv6: string
  IP Address (v6) - hex notation

  Example: 2001:DB8::1
• LastFound: string
  Timestamp when device was last discovered

  Example: 2006-01-02 15:04:05
• LastModified: string
  Timestamp when device was last modified

  Example: 2006-01-02 15:04:05
• ParentDeviceID: integer
  DeviceID of Parent for Virtual Devices

  Example: 0
• SerialNumber: string
  Serial Number

  Example:
• ShardID: integer
  Shard ID

  Example: 1
• SysContact: string
  SNMP System Contact

  Example:
• SysDescription: string
  SNMP System Description

  Example:
• SysLocation: string
  SNMP System Location

  Example:
• SysName: string
  SNMP System Name

  Example: EXAMPLE-ROUTER
• SysOID: string
  SNMP System Object ID

  Example:

{
    "properties":{
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceName":{
            "description":"Device Name (auto created in order or precidence from CustomName > DNSName > SysName > IPv6Address > IPAddress)",
            "type":"string",
            "example":"router.example.com"
        },
        "IPv4":{
            "description":"IP Address (v4)",
            "type":"string",
            "example":"192.0.2.1"
        },
        "IPv6":{
            "description":"IP Address (v6) - hex notation",
            "type":"string",
            "example":"2001:DB8::1"
        },
        "FirstFound":{
            "description":"Timestamp when device was first discovered",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "LastModified":{
            "description":"Timestamp when device was last modified",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "LastFound":{
            "description":"Timestamp when device was last discovered",
            "type":"string",
            "example":"2006-01-02 15:04:05"
        },
        "DevicePriorityID":{
            "description":"Device Priority ID",
            "type":"integer",
            "example":"1"
        },
        "ParentDeviceID":{
            "description":"DeviceID of Parent for Virtual Devices",
            "type":"integer",
            "example":"0"
        },
        "DeviceTypeCategoryID":{
            "description":"Device Type Category ID (set manually)",
            "type":"integer",
            "example":"1"
        },
        "DeviceTypeName":{
            "description":"Device Type Category Name (set manually)",
            "type":"string",
            "example":"Router"
        },
        "DeviceTypeCategoryDiscoveredID":{
            "description":"Device Type Category ID (discovered automatically)",
            "type":"integer",
            "example":"1"
        },
        "DeviceTypeCategoryDiscoveredName":{
            "description":"Device Type Category Name (discovered automatically)",
            "type":"string",
            "example":"Router"
        },
        "DeviceSNMPAccessID":{
            "description":"SNMP Access Profile ID",
            "type":"integer",
            "example":"1"
        },
        "SysOID":{
            "description":"SNMP System Object ID",
            "type":"string",
            "example":""
        },
        "SysLocation":{
            "description":"SNMP System Location",
            "type":"string",
            "example":""
        },
        "SysContact":{
            "description":"SNMP System Contact",
            "type":"string",
            "example":""
        },
        "SysDescription":{
            "description":"SNMP System Description",
            "type":"string",
            "example":""
        },
        "SerialNumber":{
            "description":"Serial Number",
            "type":"string",
            "example":""
        },
        "DeviceZoneID":{
            "description":"Device Zone ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceStateID":{
            "description":"Device State ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceStatus":{
            "description":"Device Status",
            "type":"string",
            "example":"new"
        },
        "DeviceStatusIcon":{
            "description":"Device Status icon color",
            "type":"string",
            "example":"green"
        },
        "DNSName":{
            "description":"DNS Name",
            "type":"string",
            "example":"router1.example.com"
        },
        "CustomName":{
            "description":"Custom Name",
            "type":"string",
            "example":"Custom Nice Name"
        },
        "SysName":{
            "description":"SNMP System Name",
            "type":"string",
            "example":"EXAMPLE-ROUTER"
        },
        "DeviceZoneName":{
            "description":"Device Zone Name",
            "type":"string",
            "example":"Default First Zone"
        },
        "ShardID":{
            "description":"Shard ID",
            "type":"integer",
            "example":"1"
        },
        "DeviceGroupName":{
            "description":"Device Group Name",
            "type":"string",
            "example":"root"
        },
        "GeoLocation":{
            "description":"GeoJSON Point of device location (lon, lat)",
            "type":"string",
            "example":"{\"type\": \"Point\", \"coordinates\": [0, 0]}"
        }
    },
    "type":"object"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  List of errors reported. Validation errors will be keyed by record field.
• message: string
  Response message in text

  Example: Exception thrown
• success: boolean
  Success or failure response

  Example: false

{
    "properties":{
        "success":{
            "description":"Success or failure response",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"Response message in text",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"List of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

List of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Back to Top