Overview

Hoody Notes is the collaborative notebook and document service of the Hoody platform. It powers shared notebooks, structured documents, and real-time multi-cursor editing. This page documents the service-level health endpoint used to verify that a deployment of the Notes service is running and reachable.

Health

Check service liveness and inspect runtime metadata such as build time, memory usage, process ID, and caller IP. See the Health section below.

Health

GET /api/v1/notes/health

Returns a standardized health payload with service identity, build/start timestamps, resource counters (memory, file descriptors), process ID, peer address, and the caller user-agent. Use this endpoint for readiness/liveness probes and for collecting runtime diagnostics from a running Notes service instance.

This endpoint takes no parameters.

cURL

curl -X GET https://api.hoody.com/api/v1/notes/health

SDK

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

200

{
  "status": "ok",
  "service": "notes",
  "built": "2024-11-12T08:30:00.000Z",
  "started": "2024-11-15T14:22:11.482Z",
  "memory": {
    "rss": 87495680,
    "heap": 41943040
  },
  "fds": 42,
  "pid": 12847,
  "ip": "203.0.113.42",
  "userAgent": "Hoody-CLI/1.4.2"
}

Response fields

Field	Type	Description
status	string	Service health status. Always "ok" when the endpoint responds successfully.
service	string	Service name identifier.
built	string | null	ISO 8601 build timestamp, or null if the build metadata is unavailable.
started	string	ISO 8601 timestamp marking when the service process started.
memory	object | null	Process memory snapshot. Contains rss (resident set size in bytes) and heap (heap usage in bytes, or null). May be null if the metric is not available.
fds	number | null	Number of open file descriptors, or null if the platform does not report this metric.
pid	number	Operating system process ID of the running service.
ip	string	Peer IP address of the caller as observed by the service.
userAgent	string | null	User-Agent header sent by the caller, or null if absent.