There are several REST API endpoints for monitoring the health and version of your DeepHub instance.


These endpoints are reachable without authentication. However, in order to reach them, the "guest" role in the permissions.yml file of the hub-data folder needs to be configured in the following way:

guest:
    description: A read only guest access
    '/health':
    - READ_ANY
    - READ_OWN
    '/version':
    - READ_ANY
    - READ_OWN


DeepHub Version

To determine the version, use the following API endpoint:

  • <baseURL>/deephub/version


Calling this endpoint will provide information in the following format:

{
  "hub_version": "DeepHub® 2022 R1, 2.0.0",
  "vendor": "Flowcate GmbH",
  "api_version": "1.2.1"
}


DeepHub Health

There are several API endpoints can be used to perform health checks and to retrieve system information for the DeepHub.

  • <baseURL>/deephub/health

If the DeepHub Docker container is healthy, calling the /health endpoint will respond with an empty array and the "200 OK" HTTP status code:


The health of a running DeepHub Docker container can also be determined by executing the "docker ps" command in a terminal. The status of the deephub container will indicate whether the container is healthy:


There are additional endpoints that can be used to get health information for all zones and sources (or specific zones and sources), the overall system (i.e. configuration, connections, uptime, etc.), and WebSocket connections:

  • <baseURL>/deephub/health/sources/summary

  • <baseURL>/deephub/health/sources/{source_id}

  • <baseURL>/deephub/health/system

  • <baseURL>/deephub/health/ws

  • <baseURL>/deephub/health/zones/summary

  • <baseURL>/deephub/health/zones/{zone_id}

For more information on all of these endpoints, refer to our Documentation