This space contains a listing of all supported API resources exposed by the Ribbon SBC Core Yang specs, including REST methods and schema definitions as of the 10.1 release.

A PDF version of the SBC Core 10.1 REST API is available by clicking 

here


Important Note

Beginning with SBC Core Release 11.1, REST support is deprecated in favor of RESTCONF. See SBC Core RESTCONF API.

SBC REST API User's Guide

User's guide for interacting with the SBC REST API.

Requirements - Prerequisites for using the REST APIs.

Authentication - How to authenticate API requests.

Data Model - How the SBC data is modeled and implemented. 

Resource Design - How the system works under the hood.

Samples - Usage examples.

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

(Clicking on this link will take you back to the latest SBC customer documentation space).


SBC REST API Reference Guide


Note: Beginning with SBC Core Release 11.01.00, support for REST API will be transitioned to REST CONF.


This document contains the details about Ribbon SBC Core REST Documentation.


Configuration


ParameterPresenceTypeDefaultDescription
profilesO

Profiles of configuration shared by multiple objects.
alarmsO

Alarm Management
systemO

System-level configuration.
nodeO

List of managed VMs.
addressContextO

Objects scoped to a specific IP addressing domain.
globalO

Global objects that are applicable Node wide
oamO

Operations and Maintenance objects.


Download Yang Data Model: