REST API Access
You configure enable access to the Riverbed REST API in the REST API Access page.
REST (Representational State Transfer) is a framework for API design. REST builds a simple API on top of the HTTP protocol. It is based on generic facilities of the standard HTTP protocol, including the six basic HTTP methods (GET, POST, PUT, DELETE, HEAD, INFO) and the full range of HTTP return codes. You can discover REST APIs by navigating links embedded in the resources provided by the REST API, that follow common encoding and formatting practices.
You can invoke the REST API to enable communication from one Riverbed appliance to another through REST API calls, for example:
• A SteelCentral NetProfiler communicating with a SteelCentral NetShark.
• A SteelCentral NetProfiler retrieving a QoS configuration from an appliance.
For all uses you must preconfigure an access code to authenticate communication between parties and to authorize access to protected resources.
The REST API calls are based on the trusted application flow, a scenario where you download and install an application on some host, such as your own laptop. You trust both the application and the security of the host onto that the application is installed.
For detailed information about REST API, see the SteelHead Management Console User’s Guide for SteelHead CX.
Complete the configuration as described in this table.
Control | Description |
Enable REST API Access | Enables REST API access. Before an appliance can access the REST API, you must preconfigure an access code for the system to use to authenticate access. |
Apply | Applies your settings. |
Description of Use | Specify a description. |
Generate New Access Code | Select Generate New Access Code to create a code. |
Import Existing Access Code | Select Import Existing Access Code to use an existing code. |
Add Access Code | Adds the access code. |