Health Monitoring

Health checks and update monitoring endpoints for Hoody Code instances. Use these endpoints to monitor service availability, inspect runtime metadata, and detect available updates without affecting heartbeat activity.

Health Check

GET /api/v1/code/health

Returns standardized service health status with process and runtime info. This endpoint does not count towards heartbeat activity, allowing health checks without keeping Hoody Code artificially alive.

This endpoint takes no parameters.

cURL

curl -X GET https://your-host/api/v1/code/health

SDK

const result = await client.code.health.check();

Response

{
  "status": "ok",
  "service": "hoody-code",
  "built": "2026-04-13T14:30:00Z",
  "started": "2026-04-13T15:00:00Z",
  "memory": {
    "rss": 87123456,
    "heap": 12345678
  },
  "fds": 47,
  "pid": 1,
  "ip": "198.51.100.42",
  "userAgent": "Mozilla/5.0 ..."
}

Response fields

Field	Type	Required	Description
status	string	Yes	Service status (e.g. "ok")
service	string	Yes	Service identifier (e.g. "hoody-code")
built	string | null	Yes	ISO 8601 build timestamp (mtime of the compiled entry file), or null if unavailable
started	string	Yes	ISO 8601 timestamp when the process started
memory	object | null	Yes	Process memory usage. Contains rss (resident set size in bytes) and heap (V8 heap used in bytes, or null)
fds	integer | null	Yes	Open file descriptor count (from /proc/self/fd), or null if unavailable
pid	integer	Yes	Process ID
ip	string	Yes	Remote peer IP (req.socket.remoteAddress, never X-Forwarded-For)
userAgent	string | null	Yes	Request User-Agent header

Check for Updates

GET /api/v1/code/update/check

Checks for available Hoody Code updates. Queries the GitHub releases API (unless disabled with --disable-update-check). Checks run every 6 hours and the user is notified once per week.

This endpoint takes no parameters.

cURL

curl -X GET https://your-host/api/v1/code/update/check

SDK

const result = await client.code.health.checkUpdate();

Response

{
  "current": "4.0.0",
  "latest": "4.1.0",
  "updateAvailable": true
}

Response fields

Field	Type	Required	Description
current	string	No	Current version
latest	string	No	Latest available version
updateAvailable	boolean	No	Whether a newer version is available