1 of 1

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.

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

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();

Sample RESTCONF API Docs

NSO Read-Only Interactive Docs

Sample RESTCONF API Docs

NSO Read-Only Interactive Docs

Interfaces

Single Device Config

Single Device HW / SW Platform Info

Interface Gig 4

IP Domain Name

IP Route

Router OSPF

Line Console & VTY

Single Device Config

Single Device HW / SW Platform Info

VLAN Config

Interfaces

VPC

Boot Statement

Router OSPF

Line Console & VTY

Single Device Config

Single Device HW / SW Platform Info

VRF

Interfaces

Interface GigabitEthernet 0/0/0/0 IP address

Router Static

Router OSPF

Line Console & VTY

Single Device HW / SW Platform Info

Device Platform Info

Interfaces

Interface GigabitEthernet0/1 IP Address

DNS

Access-List

Object Network

Policy-Map

Router OSPF

Object-Group

Get List of Service Instances for a Service

Get Service Info For Single Service Instance

Service Instance Log Entries

Service-List for Single Device

Device Groups

Device Single Device Group Details

Authgroups

NSO Alarms

Interfaces

Single Device Config

Single Device HW / SW Platform Info

Interface Gig 4

IP Domain Name

IP Route

Router OSPF

Line Console & VTY

Single Device Config

Single Device HW / SW Platform Info

VLAN Config

Interfaces

VPC

Boot Statement

Router OSPF

Line Console & VTY

Single Device Config

Single Device HW / SW Platform Info

VRF

Interfaces

Interface GigabitEthernet 0/0/0/0 IP address

Router Static

Router OSPF

Line Console & VTY

Single Device HW / SW Platform Info

Device Platform Info

Interfaces

Interface GigabitEthernet0/1 IP Address

DNS

Access-List

Object Network

Policy-Map

Router OSPF

Object-Group