Health Check API

Use GET /api/health as the primary liveness probe for LinkMe Edge.

This endpoint is designed for load balancers, synthetic monitors, and release smoke checks. It provides a fast JSON response that confirms whether the edge service is currently healthy enough to serve routing and API traffic.

Endpoint

Method: GET
Path: /api/health
Authentication: none
Typical latency: low, suitable for frequent polling

Response format

Healthy response:

{ "ok": true }

Unhealthy response (example):

{ "ok": false, "error": "..." }

Recommended monitor behavior

Treat HTTP 200 with { "ok": true } as healthy.
Treat { "ok": false }, non-2xx status codes, or request timeouts as unhealthy.
Configure retries before paging to reduce alert noise from short network blips.
Track both success rate and latency to catch partial degradation before total outages.

Example checks

Simple probe with curl:

curl -fsS https://li-nk.me/api/health

If you need strict JSON validation in CI/CD smoke tests:

curl -fsS https://li-nk.me/api/health | jq -e '.ok == true'

Alerting guidance

For production alerting, use at least two probe locations and short retry windows. A practical baseline is:

Interval: every 30 to 60 seconds
Timeout: 3 to 5 seconds
Failure threshold: 2 to 3 consecutive failures before opening an incident

This avoids false positives while still detecting real incidents quickly.