Sample RESTCONF API Docs

Sample NSO RESTCONF APIs.

NSO Read-Only Interactive Docs

These sample requests are Read-Only by design to work with the Always-on DevNet Sandbox.

For Read/Write requests see the Postman Collection.

Newer NSO releases (starting with 5.3) also include a | display restconf option to more easily get API paths: show running-config devices | display restconf.

Interfaces

The CLI equivalent of: show running-config devices device dist-rtr01 config interface

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:interface

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:interface', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device Config

The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device HW / SW Platform Info

The CLI equivalent of show devices device dist-rtr01 platform.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/platform

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/platform', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Interface Gig 4

The CLI equivalent of: show running-config devices device dist-rtr01 config interface GigabitEthernet 1

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:interface/GigabitEthernet=4

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:interface/GigabitEthernet=4', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

IP Domain Name

The CLI equivalent of show running-config devices device dist-rtr01 config ip domain name.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:ip/domain/name

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:ip/domain/name', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

IP Route

The CLI equivalent of show running-config devices device dist-rtr01 config ip route.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:ip/route

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:ip/route', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Router OSPF

The CLI equivalent of show running-config devices device dist-rtr01 config router ospf.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:router/ospf

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:router/ospf', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Line Console & VTY

The CLI equivalent of show running-config devices device dist-rtr01 config line

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:line

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-rtr01/config/tailf-ned-cisco-ios:line', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device Config

The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device HW / SW Platform Info

The CLI equivalent of show devices device dist-sw01 platform.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/platform

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/platform', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

VLAN Config

The CLI equivalent of show running-config devices device dist-sw01 config vlan.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:vlan

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:vlan', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Interfaces

The CLI equivalent of show running-config devices device dist-sw01 config interface

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:interface

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:interface', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

VPC

The CLI equivalent of show running-config devices device dist-sw01 config vpc

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:vpc

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:vpc', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Boot Statement

The CLI equivalent of show running-config devices device dist-sw01 config boot

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:boot

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:boot', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Router OSPF

The CLI equivalent of show running-config devices device dist-sw01 config router ospf

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:router

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:router', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Line Console & VTY

The CLI equivalent of show running-config devices device dist-sw01 config line

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:line

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/config/tailf-ned-cisco-nx:line', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device Config

The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device HW / SW Platform Info

The CLI equivalent of show devices device core-rtr01 platform

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/platform

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/platform', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

VRF

The CLI equivalent of show running-config devices device core-rtr01 config vrf

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:vrf

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:vrf', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Interfaces

The CLI equivalent of show running-config devices device core-rtr01 config interface

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:interface

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:interface', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Interface GigabitEthernet 0/0/0/0 IP address

The CLI equivalent of show running-config devices device core-rtr01 config interface GigabitEthernet 0/0/0/0 ip address

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:interface/GigabitEthernet=0%2F0%2F0%2F0/ipv4/address/ip

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:interface/GigabitEthernet=0%2F0%2F0%2F0/ipv4/address/ip', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Router Static

The CLI equivalent of show running-config devices device core-rtr01 config router static

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:router/static

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:router/static', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Router OSPF

The CLI equivalent of show running-config devices device core-rtr01 config router ospf

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:router/ospf

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:router/ospf', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Line Console & VTY

The CLI equivalent of show running-config devices device core-rtr01 config line

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:line

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=core-rtr01/config/tailf-ned-cisco-ios-xr:line', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Single Device HW / SW Platform Info

The CLI equivalent of show running-config devices device DEVICENAME. This returns both the device config and the NSO app config for that device.

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Device Platform Info

The CLI equivalent of show devices device edge-firewall01 platform

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/platform

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/platform', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Interfaces

The CLI equivalent of show running-config devices device edge-firewall01 config interface

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:interface

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:interface', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Interface GigabitEthernet0/1 IP Address

The CLI equivalent of show running-config devices device edge-firewall01 config interface GigabitEthernet 0/1 ip address

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:interface/GigabitEthernet=0%2F1/ip/address/ip/host-ip

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:interface/GigabitEthernet=0%2F1/ip/address/ip/host-ip', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

DNS

The CLI equivalent of show running-config devices device edge-firewall01 config dns

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:dns

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:dns', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Access-List

The CLI equivalent of show running-config devices device edge-firewall01 config access-list

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:access-list

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:access-list', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Object Network

The CLI equivalent of show running-config devices device edge-firewall01 config object

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:object

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:object', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Policy-Map

The CLI equivalent of show running-config devices device edge-firewall01 config policy-map

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:policy-map

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:policy-map', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Router OSPF

The CLI equivalent of show running-config devices device edge-firewall01 config router ospf

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:router/ospf

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:router/ospf', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Object-Group

The CLI equivalent of show running-config devices device edge-firewall01 config object-group

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:object-group

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=edge-firewall01/config/tailf-ned-cisco-asa:object-group', {
    method: 'GET',
    headers: {
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Get List of Service Instances for a Service

Shows all service instances. In this case we have just one. CLI equivalent is show running-config svi_verify_example

GEThttps://sandbox-nso-1.cisco.com/restconf/data/svi_verify_example:svi_verify_example

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/svi_verify_example:svi_verify_example', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+xml",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Get Service Info For Single Service Instance

Show the service instance inputs for a single service instance called "first-instance." The CLI equivalent is show running-config svi_verify_example first-instance

GEThttps://sandbox-nso-1.cisco.com/restconf/data/svi_verify_example:svi_verify_example=first-instance

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/svi_verify_example:svi_verify_example=first-instance', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+xml",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Service Instance Log Entries

Shows logs for when services have errors. CLI equivalent is show svi_verify_example log

GEThttps://sandbox-nso-1.cisco.com/restconf/data/svi_verify_example:svi_verify_example=first-instance/log

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/svi_verify_example:svi_verify_example=first-instance/log', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+xml",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Service-List for Single Device

shows the list of services that a device is participating in. CLI equivalent is show devices device service-list for a full list or show devices device dist-sw01 service-list for a single device

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/service-list

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device=dist-sw01/service-list', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+xml",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Device Groups

Device Groups can be nested, in this case the ALL group includes the other groups and was manually created. CLI equivalent show running-config devices device-group

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device-group

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device-group', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+json",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Device Single Device Group Details

You can view the contents of a single device group. CLI equivalent show running-config devices device-group IOS-DEVICES

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device-group=IOS-DEVICES

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/device-group=IOS-DEVICES', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+json",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

Authgroups

Credentials are stored in AES encrypted strings, but can be accessed over the API. CLI equivalent show running-config devices authgroups

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/authgroups

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs:devices/authgroups', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+json",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();

NSO Alarms

NSO keeps track of alarms such as failing to connect to a device. CLI equivalent show alarms

GEThttps://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs-alarms:alarms

Header parameters

Response

200

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://sandbox-nso-1.cisco.com/restconf/data/tailf-ncs-alarms:alarms', {
    method: 'GET',
    headers: {
      "Content-Type": "application/yang-data+json",
      "Accept": "application/yang-data+json"
    },
});
const data = await response.json();