v1

latestOpenAPI 3.0.02026-07-243339471.1 MB

Devices

Delete a device by serial number

This API endpoint deletes a network device based on the provided serial number.

delete/network-monitoring/v1/devices/{serial-number}

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

The serial number of the device.

Response

Details of a deleted device, including Access Point or Switch or Gateway.

serialNumberstring const required

The device serial number.

macAddressstring mac required

MAC address for the client.

deviceNamestring const required

The name of the device.

deviceType'ACCESS_POINT' | 'SWITCH' | 'GATEWAY' required

A string indicating the networking device type.

modelstring const

Hardware model of the device.

partNumberstring const

The part number of the device.

deploymentstring const

The operating mode of the device.

rolestring const

Role of the device in the network-topology.

deviceFunctionstring const

Device function (persona) of the device.

firmwareVersionstring const

Firmware version currently running on the device.

ipv4string ipv4

IPv4 address of the device.

ipv6string ipv6

IPv6 address of the device.

status'ONLINE' | 'OFFLINE'

Status of the device, which can be either ONLINE or OFFLINE.

uptimeInMillisnumber double

Elapsed time in milliseconds since the device's last boot. This value will be null if the device is offline.

lastSeenAtstring date-time

An RFC 3339 date-time indicating the last detected time of the device in the system. If the device is online, this value will be null.

siteIdstring const required

ID of the Site in which the device is present.

{"stackTrail":"components:schemas:BuildingId","oasType":"schema","type":"unknown","description":"Building ID associated with the device in UUID format. Omitted if no specific building is associated with the device.\n"}

{"stackTrail":"components:schemas:FloorId","oasType":"schema","type":"unknown","description":"Floor ID associated with the device in UUID format.\n"}

configStatusstring const

Config status of the device. Possible values are Synchronized, Out of Sync, Update in Progress, and Synchronized with Limitations.

configLastModifiedAtstring date-time

An RFC 3339 date-time indicating the last config modified time of the device.

siteNamestring const

SiteName represents the name of the site where the device is located. This name is used to identify and manage devices based on their physical location, allowing for better organization and tracking.

clusterNamestring const

The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.

notesstring const

Notes for the device.

idstring const required

Primary identifier for the resource.

typestring const required

The type of the resource.

Example response

{
  "serialNumber": "CMZR001874",
  "macAddress": "bb:5d:11:85:c0:00",
  "deviceName": "ArubaAP",
  "deviceType": "ACCESS_POINT",
  "model": "AP-115",
  "partNumber": "JZ336A",
  "deployment": "Standalone",
  "role": "Conductor",
  "deviceFunction": "Instant",
  "firmwareVersion": "8.5.2.0_59123",
  "ipv4": "114.191.59.254",
  "ipv6": "10.27.119.19",
  "status": "ONLINE",
  "uptimeInMillis": 1702794777,
  "lastSeenAt": null,
  "siteId": "1120972196",
  "buildingId": "1120972196_1",
  "floorId": "1120972196_1_",
  "configStatus": null,
  "configLastModifiedAt": null,
  "siteName": "site-12-dec",
  "clusterName": "cluster 1",
  "notes": "Device is located in Building A, Floor 2",
  "id": "CMZR001874",
  "type": "network-monitoring/device-monitoring"
}