1 of 5

API Reference

Overview

Developer reference for NSO interfaces and APIs.

The NSO API consists of:

Northbound Interfaces (NBIs) for reading data or push configuration from another system.
APIs with Python, Java, and Erlang language bindings for extending the functionality of NSO, such as adding custom service code or exposing data through a data provider mechanism.

API Reference & Interfaces

RESTCONF API

Implementation details for RESTCONF.

The NSO RESTCONF documentation covers implementation details and extension to or deviation from the RESTCONF RFC 8040 and YANG RFC 7950 respectively. The IETF RESTCONF and YANG RFCs are the main reference guides for the NSO RESTCONF interface, while the NSO documentation complements the RFCs.

RFC Reference

NETCONF Interface

Implementation details for NETCONF.

The NSO NETCONF documentation covers implementation details and extension to or deviation from the NETCONF RFC 6241 and YANG RFC 7950 respectively. The IETF NETCONF and YANG RFCs are the main reference guides for the NSO NETCONF interface, while the NSO documentation complements the RFCs.

XPath

Implementation details for XPath.

The NSO XPath documentation covers implementation details and extension to or deviation from the XPath 1.0 documentation and YANG RFC 7950 XPath extensions respectively. The XPath 1.0 documentation and YANG RFCs are the main reference guides for the NSO XPath implementation, while the NSO documentation complements them.