Welcome
Welcome to the Riverbed Open API Overview. This guide provides a brief overview of Riverbed’s open Representational State Transfer (REST) application programming interface (API). This guide is written for application programmers who want to build tools that interact with this API framework.
About product terminology
Here’s a description of product names and related terms with their abbreviations. You’ll need to know these as you read this guide.
Term | Abbreviation | Meaning |
Representational State Transfer | REST | A framework for APIs. |
Application programming interface | API | A set of functions and procedures that allow the creation of applications that access the features and data of an operating system, application, or service. |
About document conventions
This guide uses this standard set of typographical conventions:
Convention | Meaning |
italics | Within text, new terms and emphasized words appear in italic typeface. |
boldface | Within text, CLI commands, CLI parameters, and REST API properties appear in bold typeface. |
Monospace | Code examples appear in monospace font: amnesiac > enable amnesiac # configure terminal |
< > | Values that you specify appear in angle brackets: interface <ip-address> |
[ ] | Optional keywords or variables appear in square brackets: ntp peer <ip-address> [version <number>] |
{ } | Elements that are part of a required choice appear in braces: {<interface-name> | ascii <string> | hex <string>} |
| | The pipe symbol separates alternative, mutually exclusive elements of a choice. The pipe symbol is used in conjunction with braces or brackets; the braces or brackets group the choices and identify them as required or optional: {delete <filename> | upload <filename>} |
About documentation and release notes
You can find the most current version of all Riverbed documentation on the Support site at
https://support.riverbed.com.
See the Knowledge Base for any known issues, how-to documents, system requirements, and common error messages. You can browse titles or search for keywords and strings. To access the Knowledge Base, log in to the Support site at
https://support.riverbed.com.
Each software release includes release notes. The release notes list new features, known issues, and fixed problems. To obtain the most current version of the release notes, go to the Software and Documentation section of the Support site at
https://support.riverbed.com. Examine the release notes before you begin the installation and configuration process.
Contacting Riverbed
This section describes how to contact departments within Riverbed. For some products, you might need to provide your Support ID. You can find this on the Help page of your product’s Management Console.
• Documentation—Have suggestions about Riverbed’s online documentation or printed materials? Send comments to
techpubs@riverbed.com.