Health

GET/health

Purpose

Liveness check. Confirms the service is up and reports which build is answering.

Example


curl -s http://127.0.0.1:8080/health


{ "status": "ok", "service": "orbitforge-api", "version": "0.1.0" }

Parameter	Type	Unit	Default	Required	Description
`status`	string	n/a	—	Yes	Literal `ok` when the service is answering.
`service`	string	n/a	—	Yes	Service name, `orbitforge-api`.
`version`	string	n/a	—	Yes	Build version. Worth logging alongside any result you keep.

Use in orchestration


livenessProbe:
  httpGet:
    path: /health
    port: 8080
  initialDelaySeconds: 5
  periodSeconds: 10

The endpoint takes no arguments, touches no state, and is cheap, so it is safe to poll frequently.

What it does and does not tell you

/health reports that the process is answering. It does not report that your constellations still exist.

Because the service holds constellations and scenarios in memory, a restart produces a perfectly healthy service with an empty store. A client that checks /health and then gets a 404 from an analysis endpoint has not hit a contradiction: it has found the restart.

The version field is the practical value here. When a result looks wrong, the first question is which build produced it, and this is where that is recorded.

Health

Purpose

Example

Use in orchestration

What it does and does not tell you

See also