Configuring REST API Access
You can access the Riverbed REST API framework to generate a REST API access code for use in Core pool management.
Representational State Transfer (REST) 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, which follow common encoding and formatting practices.
You generate the REST API access code on the Core that you want to be a member of the pool, and supply the access code on the Core that is the manager of the pool. The access code generates a token that is valid for 60 minutes.
The access code generates a token that is valid for 60 minutes. The pool manager must request access to the member within that time period. The token is used for any REST API access request—for example, adding a member to the pool, changing a member’s configuration, or viewing the member’s status.
To set up REST API access
1. On the Core pool member, choose Configure > Pool Management: REST API Access to display the REST API Access page.
2. Select the Enable REST API Access check box and click Apply.
3. Click Add Access Code.
4. In the Description of Use field, enter a meaningful description for the access code.
For example, include the hostname of the Core in the description.
5. Select Generate New Access Code and click Add.
The access code description appears on the Access Code Description list, along with its creator.
6. To view the access code, click the Access Code Description.
7. To apply the access code to the pool member, click Apply.
8. Copy the access code to the clipboard for use in the Core pool manager.
You use the hostname and the access code for the pool member to add the member to the pool. For the procedure, see
To create a pool.
Disabling REST API Access
You can disable REST API at any time. To remove REST API access by a pool manager, you have two options:
• Clear the Enable REST API Access check box.
• From the Access Code Description list, select the access code description and click the Remove Selected tab.
When a pool manager sends REST API requests to a member, it uses the access code to get an access token from the member. The token is then used to send the actual REST API requests to the member. The access token is valid for 60 minutes.
If you delete a REST API access code, the access token is not invalidated immediately but expires after the 60 minute time period. For this reason, Riverbed recommends that you disable REST API access by clearing the Enable REST API Access check box if you have any security concerns.