Skip to content

Karabo WebProxy

This documentation assumes some familiarity with the concepts and terminology of the Karabo Control System. The documentation for Karabo can be found at its public documentation site.

Device Overview

The Karabo WebProxy device acts a gateway between the device ecosystem of a Karabo topic and external parties.

The WebProxy offers a REST API with endpoints that allow external web clients to inspect and, subject to the appropriate security constraints, control devices in the Karabo topic where the WebProxy is.

Documentation Outline

  • REST API
    The API of the WebProxy device. A live version of the API documentation can be seen at the /doc path of a running WebProxy.
  • Use Cases
    The typical use cases the WebProxy was designed to support.
Back to top