v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Topology

Returns details for an unmanaged device of a given site.

This API provides unmanaged device details for a specific site and device mac

get/network-monitoring/v1/unmanaged-device/{mac-address}

Path parameters

mac-addressstring const required

The device mac address.

Example:a1:b2:c3:d4:e5:f6

Device MAC for which details are requested.

Query parameters

site-idstring const required

Example:123682

ID of the site for which unmanaged device details are requested.

Response

Success

idstring required

Primary identifier for the resource.

namestring

Name of the unmanaged device

serialstring

This value follows the format tpd_<mac>, where the mac address is used without colons

typestring required

Device type, e.g., Switch, Router, Access Point

macstring

MAC address of the device

supportedCapabilitystring

Capabilities supported by the device

enabledCapabilitystring

Capabilities currently enabled on the device.

descriptionstring

Additional description or notes about the device

vendorstring

Vendor or manufacturer of the device

statusstring

Operational status of the device

Example response

{
  "id": "00001",
  "name": "Unmanaged-Switch-01",
  "serial": "tpd_883a3094c340",
  "type": "Switch",
  "mac": "00:1A:2B:3C:4D:5E",
  "supportedCapability": "L2, L3, PoE",
  "enabledCapability": "L2, PoE",
  "description": "Connected unmanaged edge switch",
  "vendor": "Cisco",
  "status": "Active"
}