The healthcheck endpoint is used by our internal and public uptime monitoring systems to determine the current health of the application. You are free to make use of the heathcheck endpoint in your own application.

HealthCheck [Schema]

This type is readonly.

Name Type Description
Version xsd:string The current version number of the API.
Info xsd:string Further detailed information about the health of the API.

Making a request to the Healthcheck

The healthcheck is requested through a GET or HEAD request and does not require authentication. A HEAD request will only return a HTTP status code and not a full response body.

curl -X GET
   -H 'Content-type: application/xml'
   -H 'Accept: application/xml'
   -H 'Cache-Control: no-cache'
curl -X GET
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Cache-Control: no-cache'

Response Example

<?xml version="1.0"?>
  <Info>Database Version:</Info>
  "HealthCheck": {
    "Version": "",
    "Info": "Database Version:"