Health check

GET 
/Health

Health check

Responses

200

The API health status.

application/json

Schema

Schema

status stringnullablerequired

The current status of this entity.

version stringnullablerequired

The application version.

environment stringnullablerequired

The deployment environment name.

machineName stringnullablerequired

The name of the server machine.

uptime date-spannullablerequired

The duration since the application was last started.

checks object[]nullable
The list of individual health check results.
Array [
name stringnullablerequired
The display name of this entity.
status stringnullablerequired
The current status of this entity.
error stringnullablerequired
The error message if the health check failed.
duration date-spanrequired
The time taken to complete the health check.
metadata objectnullable
Additional metadata associated with this record.
property name* stringrequired
]
gitCommit stringnullablerequired

The Git commit hash of the deployed version.

gitBranch stringnullablerequired

The Git branch of the deployed version.

Example (from schema)

{
  "status": "string",
  "version": "string",
  "environment": "string",
  "machineName": "string",
  "uptime": "string",
  "checks": [
    {
      "name": "string",
      "status": "string",
      "error": "string",
      "duration": "string",
      "metadata": {}
    }
  ],
  "gitCommit": "string",
  "gitBranch": "string"
}

Loading...