---
title: "Get a list of devices"
method: GET
path: "/network-monitoring/v1/devices"
tags: ["Devices"]
---

# Get a list of devices

`GET /network-monitoring/v1/devices`

This API endpoint retrieves a list of network devices that are on-boarded and currently being monitored, such as access points, switches, and gateways, based on the query parameters provided. Each device in the returned list includes details like serial number, MAC address, device name, device type, IP address, status, etc. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data.

Notes: The notes field in the response will have a value only when the request is filtered by the site ID or serialNumber.

## Query parameters

- `filter` string, const
- `sort` string, const
- `limit` integer, required
- `next` string, required — Specifies the pagination cursor for the next page of resources.

## Response `200`

List of network devices, including Access Points, Switches, and Gateways, along with their details and associated pagination information.

- DeviceListResponseV1
  - `items` DeviceResponseV1[], required
    - `serialNumber` string, const, required — The device serial number.
    - `macAddress` string, mac, required — MAC address for the client.
    - `deviceName` string, const, required — The name of the device.
    - `deviceType` 'ACCESS_POINT' | 'SWITCH' | 'GATEWAY', required — A string indicating the networking device type.
    - `model` string, const — Hardware model of the device.
    - `partNumber` string, const — The part number of the device.
    - `deployment` string, const — The operating mode of the device.
    - `role` string, const — Role of the device in the network-topology.
    - `deviceFunction` string, const — Device function (persona) of the device.
    - `firmwareVersion` string, const — Firmware version currently running on the device.
    - `ipv4` string, ipv4 — IPv4 address of the device.
    - `ipv6` string, ipv6 — IPv6 address of the device.
    - `status` 'ONLINE' | 'OFFLINE' — Status of the device, which can be either ONLINE or OFFLINE.
    - `uptimeInMillis` number, double — Elapsed time in milliseconds since the device's last boot. This value will be null if the device is offline.
    - `lastSeenAt` string, 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.
    - `siteId` string, const, required — ID of the Site in which the device is present.
    - `buildingId` unknown
    - `floorId` unknown
    - `configStatus` string, const — Config status of the device. Possible values are `Synchronized`, `Out of Sync`, `Update in Progress`, and `Synchronized with Limitations`.
    - `configLastModifiedAt` string, date-time — An RFC 3339 date-time indicating the last config modified time of the device.
    - `siteName` string, 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.
    - `clusterName` string, 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.
    - `notes` string, const — Notes for the device.
    - `id` string, const, required — Primary identifier for the resource.
    - `type` string, const, required — The type of the resource.
  - `count` integer, required — Number of items in the response.
  - `total` integer — Specifies the total number of items available for a given filter query.
  - `next` string, int32, required — Indicates the next page number, null if there are no further pages.

## Other responses

- `400` — Invalid input received.
- `401` — Unauthorized. Authentication credentials are required or invalid.
- `403` — Forbidden: Access is denied.
- `429` — Too Many Requests. The user has sent too many requests in a given amount of time.
- `500` — Internal Server Error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/arubanetworks/apis/authorization.md) · [All operations](https://skmtc.net/arubanetworks/apis/authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arubanetworks/authorization/revisions/74c95058b11f/schema)