Table of Contents

REST API - Requirements
REST API - Resource Design
REST API - Authentication
REST API - REST Samples
REST API - Deployment Workflow

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

SBC Edge 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. Methods used by developers are standard HTTP methods such as; GET, PUT, POST, and DELETE.

Because the REST API is based on open standards, you can use any Web Development Programming Language or HTTP Client Library to access the API. Refer to API Requirements for more details.

API Reference

The following pages are located in the API Reference space - clicking any of these links will navigate you out of this documentation space:

Please note that this release exposes a major subset of all existing SBC Edge resources via the REST API. New (and existing) resources will be incrementally added in upcoming versions of SBC SBC Edge.

Configuration Resources

Task Resources