For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Open source Support FAQs Docs Home

Documentation API reference Release notes

Documentation API reference Release notes

Introduction
- Overview
- Authentication
Guides
Reference

Open source Support FAQs Docs Home

Reference Configuration Manager

Find devices

POST

http://localhost:3000/configuration_manager/devices

POST

/configuration_manager/devices

$ curl -X POST http://localhost:3000/configuration_manager/devices \
>      -H "Content-Type: application/json" \
>      -u "<username>:<password>" \
>      -d '{}'

1 {
2   "entity": null,
3   "total": 1,
4   "unique_device_count": 1,
5   "return_count": 1,
6   "start_index": 1,
7   "list": [
8     {
9       "name": "xr9kv01-aws",
10       "ipaddress": "10.1.6.100",
11       "port": "22",
12       "device-type": "cli",
13       "ostype": "cisco-ios-xr",
14       "host": "nso46",
15       "actions": [
16         "addDevice"
17       ],
18       "authgroup": "xr9kv-aws",
19       "address": "10.1.6.100",
20       "ned": "cisco-ios-xr",
21       "admin": true,
22       "origins": [
23         "nso46"
24       ]
25     }
26   ]
27 }

Gets a specific subset of devices for based on given options.

Was this page helpful?

Find trees which contain the specified device

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body

optionsobjectOptional

Response

Filtered/Sorted Devices

entityany

totalinteger>=0

unique_device_countinteger>=0

return_countinteger>=0

start_indexinteger>=0

listlist of objects

Errors

500

Internal Server Error