Skip to content

The Health Monitoring API provides lightweight diagnostics for Hoody Code instances. Use these endpoints to verify service availability, inspect runtime metrics, and detect available updates. The health check endpoint is excluded from heartbeat activity, so monitoring systems can poll it without extending the active lifetime of a Hoody Code process.


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.

Terminal window
curl -X GET "https://api.hoody.com/api/v1/code/health" \
-H "Authorization: Bearer <token>"
FieldTypeDescription
statusstringService status. Always "ok" when healthy.
servicestringService identifier. Always "hoody-code".
builtstring | nullISO 8601 build timestamp (mtime of the compiled entry file), or null if unavailable.
startedstringISO 8601 timestamp when the process started.
memoryobject | nullProcess memory usage. Contains rss (integer, bytes) and heap (integer | null, V8 heap used in bytes).
fdsinteger | nullOpen file descriptor count (from /proc/self/fd), or null if unavailable.
pidintegerProcess ID.
ipstringRemote peer IP (req.socket.remoteAddress, never X-Forwarded-For).
userAgentstring | nullRequest User-Agent header.

Checks for available Hoody Code updates. This endpoint queries the GitHub releases API (unless disabled with --disable-update-check) and caches results for 6 hours, notifying clients at most once per week.

This endpoint takes no parameters.

Terminal window
curl -X GET "https://api.hoody.com/api/v1/code/update/check" \
-H "Authorization: Bearer <token>"
FieldTypeDescription
currentstringCurrently installed version (e.g. "4.0.0").
lateststringLatest available version (e.g. "4.1.0").
updateAvailablebooleanWhether a newer version is available.