Local Client API

You can use an API to check the current status of the Helmut4 client.

Sending a GET request to the specified endpoint http://localhost:8880/v1/hc/info (http) or https://localhost:8881/v1/hc/info (https) will yield a response indicating whether the client is running and its connection state.

Response for a connected client (macOS)

{
    "version": "4.2.036",
    "endPoint": "https://helmut.example",
    "token": "Bearer ##token##",
    "idle": 0.0,
    "sessionToken": "b68ed27c-b288-4e37-acb6-05ccb3ea9fb8",
    "sso": null,
    "os": "MAC"
}

Response for a disconnected client (macOS)

{
    "version": "4.2.0.36",
    "endPoint": null,
    "token": null,
    "idle": 0.0,
    "sessionToken": "b68ed27c-b288-4e37-acb6-05ccb3ea9fb8",
    "sso": null,
    "os": "MAC"
}