Health check

Health check endpoint

GET /health

cURL

cURL

curl --request GET \
  --url https://api.staging.qyl.dev/health

200

{
  "status": "healthy",
  "version": "2.1.0",
  "uptime_seconds": 123,
  "components": {}
}

Response

200 - application/json

The request has succeeded.

Health check response

status · enum<string> · required

Service status

Available options: healthy, degraded, unhealthy

version · string · required

Service version

Pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

Example:

"2.1.0"

uptime_seconds · integer<int64> · required

Uptime in seconds

components · object

Component health

Show child attributes