---
title: "Returns details of neighbor devices for a given serial number."
method: GET
path: "/network-monitoring/v1/neighbours/{serial-number}"
tags: ["Topology"]
---

# Returns details of neighbor devices for a given serial number.

`GET /network-monitoring/v1/neighbours/{serial-number}`

## Request

- Base URL: `https://sso.common.cloud.hpe.com`
- URL: `https://sso.common.cloud.hpe.com/network-monitoring/v1/neighbours/{serial-number}`
- 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/neighbours/:serial-number/get.ts> (a function with typed inputs; its response is checked against the schema)

This API provides details of neighbor devices for a specific device serial number

## Path parameters

- `serial-number` string, const, required: The device serial number.

## Response `200`

Success

- Neighbours
  - `id` string, required: Primary identifier for the resource.
  - `type` string, required: Type of topology or connection data
  - `neighbours` object[]: List of neighbouring devices linked to the given device
    - `memberSerial` string: Serial number of the member device
    - `name` string: Name of the neighbouring device
    - `type` string: Type of neighbouring device
    - `serial` string: Serial number of the neighbouring device. For unmanaged devices, this value follows the format tpd_<mac>, where the mac address is used without colons
    - `health` string: Health status of the neighbour
    - `toPort` string: Port of the neighbour device connected to the local device
    - `localPort` string: Port on the local device connected to the neighbour
    - `siteId` string, const
    - `siteName` string, const: Name of the Site in which the device is present.

## 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)