System Health

The Connectware REST interface provides a unique /api/system/health endpoint that can be used to retrieve health data information about system containers.

Overview

The information provided by the endpoint are as follows:

System

Overall object key

Status: Array of system container

Name: Name of the system container

Status: Current status of the system container

Resources

Not implemented yet

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.

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