Returns details of neighbor devices for a given serial number.

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

get/network-monitoring/v1/neighbours/{serial-number}

Request

Base URL
https://sso.common.cloud.hpe.com
Auth
OAuth 2
Client credentials
Token URLhttps://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.

Path parameters

serial-numberstring const required

The device serial number.

Example:AP00000001

Device serial number for which details are requested.

Response

Success

idstring required

Primary identifier for the resource.

typestring required

Type of topology or connection data

Example response

{
  "id": "00001",
  "type": "Neighbours",
  "neighbours": [
    {
      "memberSerial": "SG90KMX08R",
      "name": "DISTR-2-VSX-Primary",
      "type": "Switch",
      "serial": "TW8AK7206R",
      "health": "Good",
      "toPort": "1/1/46",
      "localPort": "1/1/23",
      "siteId": "123682",
      "siteName": "Site1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.