Health Monitoring API

Overview

The Health Monitoring API exposes lightweight endpoints for inspecting the runtime state of a Hoody Code instance and detecting available updates. Use these endpoints to wire uptime probes, build operational dashboards, or run periodic version checks without affecting the user’s session or heartbeat activity.

All endpoints are served from the container-scoped host assigned to the Hoody Code instance.

Service health check

`GET /api/v1/code/health`

Returns standardized service health status, including process identifiers, memory usage, file descriptor count, and the remote peer IP of the caller. This endpoint does not count toward heartbeat activity, so health checks will not keep Hoody Code artificially alive when the user has otherwise gone idle.

This endpoint takes no parameters.

curl -X GET "https://acme-prod-cnt-7a3f9b-code-1.us-east-1.containers.hoody.icu/api/v1/code/health"

import { HoodyClient } from "hoody-sdk";

const client = new HoodyClient({ token: process.env.HOODY_TOKEN });

const health = await client.code.health.check();
console.log(health.status, health.pid, health.memory);

{
  "status": "ok",
  "service": "hoody-code",
  "built": "2026-04-13T14:30:00Z",
  "started": "2026-04-13T15:00:00Z",
  "memory": {
    "rss": 184549376,
    "heap": 73400320
  },
  "fds": 47,
  "pid": 1,
  "ip": "198.51.100.42",
  "userAgent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36"
}

Response fields

Field	Type	Required	Description
`status`	string	Yes	Service status. Always `"ok"` when the endpoint responds.
`service`	string	Yes	Service identifier. Always `"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 snapshot. Contains `rss` (integer, bytes) and `heap` (integer \| null, V8 heap used in bytes).
`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 whether a newer Hoody Code release is available on GitHub. The server polls the GitHub releases API every 6 hours and surfaces a notification at most once per week. Update checks can be disabled server-side with the --disable-update-check flag.

This endpoint takes no parameters.

curl -X GET "https://acme-prod-cnt-7a3f9b-code-1.us-east-1.containers.hoody.icu/api/v1/code/update/check"

import { HoodyClient } from "hoody-sdk";

const client = new HoodyClient({ token: process.env.HOODY_TOKEN });

const update = await client.code.health.checkUpdate();
if (update.updateAvailable) {
  console.log(`Update available: ${update.current} -> ${update.latest}`);
}

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

Response fields

Field	Type	Required	Description
`current`	string	No	Current installed version (for example, `"4.0.0"`).
`latest`	string	No	Latest available version (for example, `"4.1.0"`).
`updateAvailable`	boolean	No	`true` when `latest` is newer than `current`; otherwise `false`.