Giving information about the state of your registered application in Synergy

Please note that this is our alpha version. The interfaces are not yet stable and might change.

Documentation of Health Check Endpoint

For showing application status in Synergy portal, the application must implement health check REST service. It is a simple service returning information about the application status. JSON service output is following:

Example

{
"status": "UP",
"description": ""
}

  • status - application status:

    • "UP": This should be returned by the service if the application is running and providing health endpoint.

    • "SHUTTING_DOWN": This should be returned by the service if the application is running, providing health endpoint but marked to shut down.

    • " ERROR": This should be returned by the service if the application is running, providing health endpoint but emitting error status.

  • description - application status description