Retrieving More System Information

The Connectware REST interface provides a unique /api/system/info endpoint that can be used to retrieve more in depth system information.

Overview

The information provided by the endpoint are as follows:

License

In depth information about the license file used to active the currently running Connectware instance. This includes:

File A schematic display of the license features and expiration.

Name The license name. This name corresponds to an existing customer license in the Cybus Portal.

Valid The current license state. As long as a valid license is provided the value will be true.

Time

Timestamp of the query.

Version

The version of the currently running Connectware instance.

How to Access the Endpoint

Requirements

To access the REST endpoint a user has to authenticate with Connectware first. HTTP read permissions for the /api/system/info path have to be added to the user account before attempting to connect with the endpoint. To learn more about user permissions, please read the User Section of the documentation.

Example

A short example query using curl.

curl -u <USERNAME>:<PASSWORD> https://<HOSTNAME>:443/api/system/info --insecure