API Reference

Health

This endpoint lets a load balancer or uptime monitor check that the Data service is up. It is unauthenticated and returns a fixed marker; it does not open a database connection.

Endpoints 1

Paths are relative to /data-api

Check service liveness

GET /data-api/v1/health/live

Returns a marker confirming the service is running.

A lightweight liveness check. It returns a fixed healthy marker whenever the service can answer the request, and takes no parameters.

Authentication
None

Parameters

No parameters.

Returns

Returns a status marker in data.

Request
curl "$VDF_BASE_URL/data-api/v1/health/live"
Response 200
{
  "success": true,
  "data": {
    "status": "healthy",
    "service": "vdf-data-backend"
  }
}