3.0
MicroStream HomeAPI Docs

Client GUI

This is the manual for older MicroStream versions (Version < 5.0).

The new documentation (Version >= 5.0) is located at:

https://docs.microstream.one/

Based on the REST API we provide a client, which serves a convenient web user interface to browse through the storage data.

It is a runnable jar which starts a simple web server which then can be accessed by a browser of your choice.

To download it use maven

pom.xml
<repositories>
    <repository>
        <id>microstream-releases</id>
        <url>https://repo.microstream.one/repository/maven-public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>one.microstream</groupId>
        <artifactId>storage.restclient.app</artifactId>
        <version>03.00.00-MS-GA</version>
    </dependency>
</dependencies>

or this direct link:

Start the client. The port parameter is optional, default port is 8080.

java -jar storage.restclient.app-03.00.00-MS-GA.jar --port=80

Then just open http://localhost in your browser, select the base URL of the REST service and click connect.

Now you can browse through the data of the storage:

Or view the statistics:

PreviousREST APINextFAQ

Last updated