Skip to main content
Version: 10.0

rWeb API

Introduction​

rWeb provides a RESTful API for third-party applications to access configuration, filter devices, and raw traffic data. Users interact with the API over HTTPS. Requests and responses are encoded using JavaScript Object Notation (JSON).   

The rWeb platform was designed from the ground up with a comprehensive API in mind. The following figure shows the rWeb architecture and how the API plays a central role in data transfer.   

All rWeb WebUI functions use the rWeb API. This architecture assures API users that anything that can be done on rWeb WebUI can be done over the API, and that the API contains a super-set of rWeb capabilities.   

rWeb API is designed with a dynamic world in mind. Features in the API will change from time to time, but the user can always discover the structure easily and update their applications with minimal effort.

System Requirements​

Use of the rWeb API requires support for:   

  • Cookies (rWeb < 9.2.0) 
  • HTTP GET, PUT, POST and DELETE   

Any application or library that supports this range of features may be used to communicate with the rWeb API.   

Do not use a web browser to connect to the rWeb API. The API is designed for automated systems, not interactive use. Use the rWeb web application for interactive management.