This API call delivers some status information about the running backend server. Unlike the version with public access, this version of the health check contains the complete set of information.
Supported HTTP methods: GET,HEAD,OPTIONS
GET /api/v1/healthcheck
Returns an Dictionary document listing some status information about the backend server.
The Dictionary document returned contains the following keys with its values:
| Key | Description |
|---|---|
| PRODUCT | The name of this product |
| WEBSITE | The SatService website URL |
| VERSION | The software version actually running |
| SERIALNO | The software serial number |
| UPTIME | The server uptime |
| MEMORY | The memory usage of the backend |
| SESSIONS | The number of open sessions |
| WEBSOCKS | The number of open (message) websocket connections |
Parameters: none
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, the Dictionary with the status information is returned as payload. |