[16] REST Interface

API

The Panopticon Visualization Server provides a REST API that allows you to interact with the server through requests that can be scripted and automated. For example, the REST API supports downloading data, uploading workbooks, getting server usage statistics and much more. The API follows the OpenAPI Specification from Swagger.io, an API description format. Thereby, a web interface for the REST API including documentation is available, to facilitate exploration and testing of the REST API. To enable the web interface for testing, and the documentation in it, you first have to set documentation.enabled=true in Panopticon.properties.

Updating the property file requires the Panopticon Visualization Server application to be restarted, which is either just the application or the entire Tomcat server. Once the Panopticon Visualization Server has been restarted, the REST API can be accessed from the browser. Use the following address to view and interact with the documentation: http://[host]:[port]/[serverappname]/server/swagger-ui.html

The OpenAPI specification can be accessed on the following address: http://[host]:[port]/[serverappname]/server/swagger-ui.html

Example: http://localhost:8080/panopticon/server/swagger-ui.html