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

# Get a device inventory list

`GET /network-monitoring/v1/device-inventory`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/device-inventory`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://sso.common.cloud.hpe.com/as/token.oauth2`
- TypeScript: <https://skmtc.dev/arubanetworks/apis/authorization/docs/network-monitoring/v1/device-inventory/get.ts> (a function with typed inputs; its response is checked against the schema)

This API endpoint retrieves a list of network devices that are present in inventory, such as access points, switches, and gateways. The API includes devices yet to be on-boarded, as well as those already on-boarded and currently being monitored by the system. Each device in the returned list includes details like serial number, device name, part number, deployment, device function, scope ID, device group ID, whether the device is provisioned, etc. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data.

## Query parameters

- `filter` string, const
- `sort` string, const
- `site-assigned` 'ASSIGNED' | 'UNASSIGNED'
- `limit` integer: Specifies the number of results to be returned
- `next` string: Specifies the pagination cursor for the next page of resources.

## Response `200`

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

- DeviceInventoryResponseV1
  - `items` object[], 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.
    - `status` 'ONLINE' | 'OFFLINE': Status of the device, which can be either ONLINE or OFFLINE.
    - `deviceGroupId` string, const: DeviceGroupId property represents the unique identifier for the group to which the device belongs. This identifier is used to group devices that share common characteristics or are part of the same operational group, facilitating easier management and monitoring.
    - `scopeId` string, const: ScopeId represents the unique identifier for the asset scope associated with the device. This identifier is used to categorize and manage assets within a specific scope, allowing for better organization and tracking of devices.
    - `isProvisioned` string, const: IsProvisioned indicates the provisioning state of the device. This property specifies whether the device has been successfully provisioned and is ready for use. For example, a value of `YES` indicates that the device has been provisioned, while a value of `NO` indicates that the device has not been provisioned.
    - `siteId` string, const, required: ID of the Site in which the device is present.
    - `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.
    - `deviceGroupName` string, const: DeviceGroupName represents the name of the group to which the device belongs. This name is used to categorize and manage devices that share common characteristics or are part of the same operational group.
    - `stackId` string, const: StackId represents the unique identifier for the stack to which the device belongs.
    - `tier` string, const: Tier represents the tier of the license associated with the device. This tier indicates the level of features and capabilities that are available for the device based on the license.
    - `subscriptionKey` string, const: Subscription license key associated with 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.dev/arubanetworks/apis/authorization.md) - [All operations](https://skmtc.dev/arubanetworks/apis/authorization/llms.txt) - [OpenAPI document](https://skmtc.dev/arubanetworks/apis/authorization/revisions/74c95058b11f?raw)