GET /v1/health
Reports whether the service and its dependencies are working.
| Method and path | GET /v1/health |
| Key | not needed |
| Response | application/json |
| Lean OpenAPI | getHealth |
| Full contract | getHealth |
Example
Section titled “Example”curl -s https://api.satellitedata.net/v1/healthThe response has:
| Member | Meaning |
|---|---|
status |
ok when every check passes, degraded when a dependency is failing |
version |
the deployed build |
schemaVersion |
the schema v1 release in force |
time |
server time |
checks |
one entry per dependency, each ok, degraded or down |
In lean v1 the checks are earth-search and renderer. The response is never cached. An upstream failure makes the status degraded but the route still answers 200. The report contains no hostnames or error messages.
Errors
Section titled “Errors”internal (500).