Health check

GET

/v1/health

const url = 'http://localhost:3000/v1/health';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/v1/health

Liveness only — “is this process up”, with no dependency fan-in (that is /v1/health/ready). version identifies the running build so a deploy can be confirmed from outside: it is the git commit the image was built from, or dev when the image was built without one (a local docker build, or pnpm dev).

Responses

200

application/json

object

status

required

string

version

required

string

Example

{
  "status": "ok",
  "version": "c71e57b"
}