Get the neighbors of a device by topology type

Use this API to get specific neighbors of a device according to the specified topology type.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Topology/Devices/Neighbors

Yes

Parameters

Name

Description

Token*required
(header)

Place the token received from the API Log in to get an authentication token.

hostname*required
(query)

The hostname of a device.

topoType*required
(query)

Specify the topology type of the neighbors to be returned, such as L2_Topo_Type, L3_Topo_Type, Ipv6_L3_Topo_Type, and VPN_Topo_Type.

Response

Parameter

Type

Description

Example

neighbors

list

A list of returned neighbors.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "neighbors": [
    {
      "hostname": "Bos-Core1",
      "interface": "FastEthernet0/1 172.24.32.226/28"
    }
  ]

hostname

string

The hostname of the neighbor device.

interface

string

The name of the neighbor interface.

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.