OElite Business Suite App
UI Menus & Layouts
Health Check API
3 min
production api endpoint https //ama api oelite io production api swagger https //ama api oelite io/swagger 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 production api endpoint https //ama api oelite io production api swagger https //ama api oelite io/swagger 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 required description here param2 optional 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