Health Check API
Health Checks
For checking the server APIs health, please make 2 API calls as listed below. Please make sure both responses return successful messages before carrying further function calls.
/platform/ping
This endpoint should return "pong" as a response to indicate the server is connectable
/healthz
This endpoint should return "Healthy" as response to indicate the server is functioning. The health check on server carries a set of checks including logic flow check, database connection check and performance check.
Health Checks
For checking the server APIs health, please make 2 calls.
Server connection status check
This endpoint should return "pong" as a response to indicate the server is connectable. The server should return string "pong" very quickly as it does not carry any logic checks.
This check is useful for your application to evaluate whether the connection in good quality (slow/fast).
Parameters
No parameter is required.
Response
A string "pong" should be expected. If not, there's a problem connecting to the server.
GET
/platform/ping
Response
"pong"
Server health check
This endpoint should return "
Parameters
param1 REQUIRED
description here...
param2 optional
description here
Response
A string will be returned. The value can be any of the following:
Healthy
indicates the server is running in good health.
Degraded
indicates the server is running however in degraded performance.
Unhealthy
indicates the server is having problems and may not be functioning properly.
GET
/platform/ping
Response