Skip to main content

Healthcheck

The oryelle backend provides a healthcheck endpoint at /api/v1/_healthcheck that allows you to monitor the health and availability of your instance. This endpoint is useful for:

  • Container orchestration platforms to verify service health
  • Load balancers to determine if the service should receive traffic
  • Monitoring systems to track uptime and availability

The healthcheck endpoint returns a JSON response with the following structure:

GET /api/v1/_healthcheck
{
  "status": "ok",
  "timestamp": "2025-06-13T20:41:36.873Z"
}