API health check

Check if the FlowDrop API is running and responsive. This endpoint is at the root level following industry conventions for Kubernetes liveness/readiness probes and load balancer health checks.

GET /health

API health check

cURL

curl --request GET \
  --url http://localhost:5173/api/flowdrop/health

200

{
  "status": "healthy",
  "timestamp": "2023-11-07T05:31:56Z",
  "version": "1.0.0",
  "service": "FlowDrop API",
  "uptime": 3600
}

Response

200

application/json

API is healthy

status · string

Example:

"healthy"

timestamp · string<date-time>

version · string

Example:

"1.0.0"

service · string

Example:

"FlowDrop API"

uptime · integer

Uptime in seconds

Example:

3600