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

REpresentational State Transfer (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: REST API uses open standards. Any language may be used to access the API (C , Java, etc.).


The Ribbon SBC Core REST APIs provide access to resources via URI paths. To use a REST 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

REST APIs are included beginning with SBC release 4.2.x.

The REST API is based on open standards allowing you to use any Web Development Programming Language or HTTP Client Library to access the API.

Developer's Guide

Requirements – Prerequisites for using the REST APIs

Authentication – How to authenticate API requests

Data Model – How the SBC data is modelled and implemented

API Methods and Message Headers – How the system works under the hood

Samples – Usage examples

Deployment Workflow – Administrators guide for deploying a single SBC configuration onto multiple SBCs

API Reference

The SBC Core REST APIs are located in the REST API Reference Guide.

  • No labels