Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/soker90/finper/llms.txt

Use this file to discover all available pages before exploring further.

The health check endpoint provides a quick liveness signal for the Finper API server. It requires no authentication and returns immediately, making it suitable for automated probes that run frequently without consuming JWT tokens.

​
GET /api/monit/health

Check that the API server is running and reachable. Authentication: Not required. 
curl http://localhost:3008/api/monit/health
Response 200 
{ "status": "ok" }
This endpoint is designed for automated monitoring. Common use cases:
  • Docker — HEALTHCHECK CMD curl -f http://localhost:3008/api/monit/health || exit 1
  • Kubernetes — liveness or readiness probe with httpGet.path: /api/monit/health
  • Uptime monitors — ping every 30–60 seconds; alert on non-200 responses
The endpoint does not check database connectivity or downstream services — it only confirms the Node.js process is alive and the Express router is responding.

Build docs developers (and LLMs) love

Get started for freeTalk to us