/HealthCheck GET

This returns an array of health check responses indicating individual server health.



Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.


NOTE: Variables to place in the query string of the request.

Parameter Data Type Valid Values Description
HealthCheck Flags Enum Any combination of 1,2 and 4
  • 1 - Elastic Search
  • 2 - Scale Out (SOSS)
  • 4 - Database


If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
HealthChecker string The health checkers that have executed.
Server string The server that executed the health check.
TimeTaken long positive # The time taken to execute the health check in milliseconds.
DidPassHealthCheck boolean true/false Whether or not the current health check was successful.
Message string Any message about the health check.
Exception Exception Any exception that may have occured during the health check.