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

Get device details

GET

http://localhost:3000/configuration_manager/devices/:name

GET

/configuration_manager/devices/:name

$ curl http://localhost:3000/configuration_manager/devices/name \
>      -u "<username>:<password>"

1 {
2   "name": "xr9kv01-aws",
3   "ipaddress": "10.1.6.100",
4   "port": "22",
5   "device-type": "cli",
6   "ostype": "cisco-ios-xr",
7   "host": "nso46",
8   "actions": [
9     "addDevice"
10   ],
11   "authgroup": "xr9kv-aws",
12   "address": "10.1.6.100",
13   "ned": "cisco-ios-xr",
14   "admin": true,
15   "origins": [
16     "nso46"
17   ]
18 }

Returns detailed information for a specific device, based on its device name.

Was this page helpful?

Get device group by ID

Authentication

AuthorizationBasic

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

Path parameters

namestringRequired

Device name

Response

Device's details

namestring

ipaddressstring

portstring

device-typestring

ostypestring

hoststring

actionslist of strings

authgroupstring

addressstring

nedstring

adminboolean

originslist of strings

Errors

500

Internal Server Error