1. REST API for Unified Assurance Core
  2. Tasks
  3. Device Catalog
  4. Device Views

Get Device Details

get

/api/device/DeviceViews

Gets the details of the specified device.
An example path with query parameters is:
/api/device/DeviceViews?DeviceName=router.example.com;z3&DetailLevel=Minimal

Request

Query Parameters
  • The level of detail to retrieve. Use Minimal to retrieve only the device name or Full to retrieve all the information on the device. The default value is Full.
    Allowed Values: [ "Minimal", "Full" ]
    Example:
    Minimal
  • A serialized device name or comma-separated list of serialized device names. Only used if the DeviceSource parameter is set to Device or MultipleDevices.
    Example:
    router.example.com;z1 OR router.example.com
  • The ID of the device zone to get performance data for. Deprecated. Use serialized device name instead.
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The list of details of the specified device.
Show Source
Example:
[
    {
        "PropertyName":"Device Name",
        "PropertyValue":"router.example.com"
    },
    {
        "PropertyName":"Timestamp Added",
        "PropertyValue":"2022-10-27 07:23:09"
    },
    {
        "PropertyName":"Timestamp Modified",
        "PropertyValue":"2023-05-16 22:30:26"
    },
    {
        "PropertyName":"IP Address",
        "PropertyValue":"192.0.2.1"
    },
    {
        "PropertyName":"IPv6 Address",
        "PropertyValue":null
    },
    {
        "PropertyName":"Device ID",
        "PropertyValue":"43"
    },
    {
        "PropertyName":"Custom Name",
        "PropertyValue":""
    },
    {
        "PropertyName":"DNS Name",
        "PropertyValue":"example.com"
    },
    {
        "PropertyName":"Sys Name",
        "PropertyValue":"dev1-col2"
    },
    {
        "PropertyName":"Sys OID",
        "PropertyValue":"1.2.3.4"
    },
    {
        "PropertyName":"Description",
        "PropertyValue":"Linux router 1.2.3.4x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
    },
    {
        "PropertyName":"Location",
        "PropertyValue":"Unknown"
    },
    {
        "PropertyName":"Contact",
        "PropertyValue":"root@localhost"
    },
    {
        "PropertyName":"Services",
        "PropertyValue":"0"
    },
    {
        "PropertyName":"IP Forwarding",
        "PropertyValue":"1"
    },
    {
        "PropertyName":"Serial Number",
        "PropertyValue":""
    },
    {
        "PropertyName":"Device Type Name",
        "PropertyValue":"Linux"
    },
    {
        "PropertyName":"Device Type Category",
        "PropertyValue":"Appliance"
    },
    {
        "PropertyName":"GeoLocation",
        "PropertyValue":"{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
    }
]
Nested Schema : items
Match One Schema
Show Source
Nested Schema : deviceDeviceViews
Type: object
Show Source
Nested Schema : deviceDeviceViewsFull
Type: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top

Examples

The following example shows how to use query parameters in Get Device Details requests. The parameters specify the device's serialized name (the device name appended with zone number) and specifies the detail level.

http://hostFQDN/api/device/DeviceViews?DeviceName=router.example.com;z3&DetailLevel=Minimal

You can submit a request using cURL, an API client, or your browser.

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "total": "1",
  "data": [
    {
      "PropertyName": "Device Name",
      "PropertyValue": "router.example.com"
    },
    {
      "PropertyName": "Timestamp Added",
      "PropertyValue": "2022-10-27 07:23:09"
    },
    {
      "PropertyName": "Timestamp Modified",
      "PropertyValue": "2023-05-16 22:30:26"
    },
    {
      "PropertyName": "IP Address",
      "PropertyValue": "192.0.2.1"
    },
    {
      "PropertyName": "IPv6 Address",
      "PropertyValue": null
    },
    {
      "PropertyName": "Device ID",
      "PropertyValue": "43"
    },
    {
      "PropertyName": "Custom Name",
      "PropertyValue": ""
    },
    {
      "PropertyName": "DNS Name",
      "PropertyValue": "dev1.example.com"
    },
    {
      "PropertyName": "Sys Name",
      "PropertyValue": "dev1"
    },
    {
      "PropertyName": "Sys OID",
      "PropertyValue": "1.2.3.4"
    },
    {
      "PropertyName": "Description",
      "PropertyValue": "Linux router 1.2.3.4.x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
    },
    {
      "PropertyName": "Location",
      "PropertyValue": "Unknown"
    },
    {
      "PropertyName": "Contact",
      "PropertyValue": "root@localhost"
    },
    {
      "PropertyName": "Services",
      "PropertyValue": "0"
    },
    {
      "PropertyName": "IP Forwarding",
      "PropertyValue": "1"
    },
    {
      "PropertyName": "Serial Number",
      "PropertyValue": ""
    },
    {
      "PropertyName": "Device Type Name",
      "PropertyValue": "Linux"
    },
    {
      "PropertyName": "Device Type Category",
      "PropertyValue": "Appliance"
    },
    {
      "PropertyName": "GeoLocation",
      "PropertyValue": "{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
    }
  ]
}
Back to Top