Get the gateway information of a device

This function returns the gateway information of a device based on IP or hostname.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Path/Gateways

Yes

Parameters

Name

Description

Token*required
(header)

The token can be obtained by sending a POST request to the log in session endpoint and provide valid credentials.

ipOrHost*required
(query)

The IP or hostname of a device.

Response

Parameter

Type

Description

Example

gatewayList

array

A list of returned gateway devices. The list contains the following subparameters:

▪ip (string): the IP address of a gateway.

▪devName (string): the hostname of a gateway.

▪intfName (string): the name of the gateway interface.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "gatewayList": [
    {
      "ip": "string",
      "devName": "string",
      "intfName": "string"
    }
  ]
}

statusCode

integer

Code issued by NetBrain server indicating the execution result.

statusDescription

string

The explanation of the status code.