GET Ping/Health

Used to monitor healthiness of API. Checks both API availability and database responsiveness.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Health status and database speed (milliseconds).

HealthCheckRestResult
NameDescriptionTypeAdditional information
DatabaseSpeedMilliseconds

The speed (milliseconds) of calling top 1 query.

 integer

None.
Status

Overall status for API availability.

 HealthStatus

None.

Response Formats

application/json, text/json

Sample: 
{
  "DatabaseSpeedMilliseconds": 1,
  "Status": 0
}

application/xml, text/xml

Sample: 
<HealthCheckRestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api360.Models">
  <DatabaseSpeedMilliseconds>1</DatabaseSpeedMilliseconds>
  <Status>Unhealthy</Status>
</HealthCheckRestResult>