The RESTCONF APIs are provided for administrators who want to script SBC interactions, and for developers who want to programmatically integrate the Ribbon RESTCONF API into their application.

Representational State Transfer Configuration Protocol (REST) API is a simple, stateless architecture style ( not a protocol) that uses the  HTTP/HTTPS method ( such as GET, PUT,POST, DELETE)  to retrieve the management information from the database. The main advantage is that it has a simple interfaces and can be can be modified even when the application is running.

REST has the following properties:

  • Stateless: No client context is stored on the server. A request from the client will contain all the necessary information required to process the request.

  • Client-Server model: In a client-server model, clients are associated with the user interface, and the servers manage data storage behind the interface. This allows a separation between the client and server.

  • Cacheable: Improvement in scalability and performance when the client caches responses.
  • Language–independent: RESTCONF API uses open standards. Any language may be used to access the API (C, Java, and so on).


The Ribbon RESTCONF API RESTCONF APIs provide access to resources via URI paths. To use a RESTCONF API, your application makes HTTPs requests and parses the responses. Currently, the only supported response format is XML. The methods used by developers are standard HTTP methods such as; GET, PUT, POST, PATCH and DELETE.

Functionality enhancement

RESTCONF APIs are included beginning with SBC release xx.xx

  • No labels