API Reference

Health

A lightweight liveness check for monitoring and load balancers. It takes no authentication and does no work beyond confirming the service is up.

Endpoints 1

Paths are relative to /networks-api

Check service health

GET /networks-api/health

Returns a static object confirming the service is running.

Returns immediately with a small JSON object. The endpoint performs no dependency checks, so a 200 means the API process is up, not that every downstream system is reachable.

Authentication
None

Parameters

No parameters.

Returns

Returns { "status": "ok" }.

Request
curl "$VDF_BASE_URL/networks-api/health"
Response 200
{
  "status": "ok"
}