Skip to content

Fortified IDDocs

Health check

Health check endpoint for FortifiedID EID Server readiness detection.

EID Server exposes a health check endpoint that external systems can poll to determine when the server is up and all modules have been deployed successfully.

Endpoint

Section titled “Endpoint”
GET /public/api/health

The endpoint requires no authentication and is served on the public HTTP listener (port 8080 by default).

Response

Section titled “Response”

A successful response returns HTTP 200 with a JSON body:

{
    "status": "UP",
    "timestamp": 1720000000000
}

timestamp is the server time in milliseconds since the Unix epoch at the moment of the request.

Any response other than 200 — or no response at all — indicates the server is not yet ready or has failed to start.

Readiness behaviour

Section titled “Readiness behaviour”

The endpoint only becomes available after all configured modules have been deployed successfully. This makes it suitable as a readiness probe: polling it will produce no response or a connection error until the server has finished initialising, then return 200 once it is ready to serve traffic.

Usage examples

Section titled “Usage examples”

Manual check:

Terminal window
curl -sf http://localhost:8080/public/api/health

Container readiness probe (Docker / Podman):

Terminal window
podman run \
  --health-cmd "curl -sf http://localhost:8080/public/api/health || exit 1" \
  --health-interval 10s \
  --health-start-period 30s \
  --health-retries 5 \
  ...

Kubernetes readiness probe:

readinessProbe:
  httpGet:
    path: /public/api/health
    port: 8080
  initialDelaySeconds: 30
  periodSeconds: 10
  failureThreshold: 5