Skip to main content

Application Health

Application Health

Responses
200

Backend Application is Healthy and reachable.

Schema
status string

Possible values: [Healthy, Degraded, Unhealthy]

Describes the system statuses via health check endpoint. "Healthy" indicates that the checks performed indicate that system components are working as intended. "Degraded" indicates that system checks that did succeed but are slow or unstable. E.g. a simple database query did succeed but took longer than expected. "Unhealthy" indicates that some system checks have failed.

totalDuration hour:minute:second.fraction

The total amount of time taken to perform a health check on the backend application.

entries object[]
description string

A brief description of the specific test being done.

duration hour:minute:second.fraction

The total amount of time taken to perform a health check on the backend application.

status string

Possible values: [Healthy, Degraded, Unhealthy]

Describes the result of this test in a readable form. For detailed explanation on the status, refer to the schema outline in the response of /api/health.

tags string[]

This field is not utilised, kindly ignore.