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 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. ).
For more details, refer to REST API Reference Guide.
On the SBC main screen, go to All > System > Admin > Rest.
Choose the desired Admin option from the drop-down list to view REST parameters.
The Rest window is displayed
Admin - Rest parameters
The following field is displayed:
Admin - Rest parameters
Parameter | Description |
|---|---|
State | Enable this flag to allow SBC to support REST API. |
Make the required changes and click Save.
Overview
Content Tools