Get all devices in a domain

Use this API to get the corresponding device by an IP address or device name. If neither hostname nor IP address is set, return all devices in the current domain.

Resource Information

Method

URL

Required authentication

GET

/V1/CMDB/Devices

Yes

Parameters

Name

Description

Token*required
(header)

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

hostname
(query)

Enter hostname to find the corresponding device’s details.

▪If neither hostname or IP address is set, all devices of the current domain will be returned.

▪If both hostname and IP address are set, the hostname will take precedence.

ip
(query)

Enter an IP address to find the corresponding device’s details.

▪If neither hostname or IP address is set, all devices of the current domain will be returned.

▪If both hostname and IP address are set, the hostname will take precedence.

Response

Parameter

Type

Description

Example

devices

list

A list with of devices in a domain.

{
  "statusCode": 790200,
  "statusDescription": "success",
  "devices": [
    {
      "id": "7d47c791-84cb-4bdb-9d2c-abbfafe71b2e",
      "mgmtIP": "10.10.7.253",
      "hostname": "Bos-Core",
      "deviceTypeName": "Cisco Router"
    }
  ]
}

id

string

The ID of a device.

mgmtIP

string

The management IP of a device.

hostname

string

The hostname of a device.

deviceTypename

string

The device type of a device.

statusCode

integer

The returned status code of executing the API.

statusDescription

string

The explanation of the status code.