SBC Core REST API

Welcome to the

Unable to show "metadata-from": No such page "_space_variables"

REST API Reference documentation space.

In addition to the REST API User's Guide, this space contains a listing of all supported API resources exposed by the

Unable to show "metadata-from": No such page "_space_variables"

Yang specs, including REST methods and schema definitions.

Important Note

Beginning with SBC Core Release 11.1, REST support will be deprecated in favor of RESTCONF.

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).

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.

Parameter	Presence	Description
profiles	O	Profiles of configuration shared by multiple objects.
alarms	O	Alarm Management
system	O	System-level configuration.
node	O	List of managed VMs.
addressContext	O	Objects scoped to a specific IP addressing domain.
global	O	Global objects that are applicable Node wide
oam	O	Operations and Maintenance objects.

Space shortcuts