---
title: "Liveness probe"
method: GET
path: "/api/health"
---

# Liveness probe

`GET /api/health`

## Request

- Base URL: `https://api.engram.page`
- URL: `https://api.engram.page/api/health`
- Auth: none required

Cheap liveness check. Always 200 if the app is up.

## Response `200`

Service is up

- HealthStatus: Service health status.
  - `build_sha` string, nullable: Commit the running image was built from, baked in at build time. null on local/self-host builds where it was not supplied.
  - `checks` object: Per-dependency status map (present on /deep only)
  - `status` string, required: ok | degraded
  - `version` string: Running app version from mix.exs. Sticky between release-please cuts, so it does NOT change on a non-release deploy — use build_sha to tell what code is actually running.

---

[API](https://skmtc.dev/engram/apis/engram-api.md) · [All operations](https://skmtc.dev/engram/apis/engram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/engram/apis/engram-api/revisions/8c4c2eec29dc?raw)