Health Check
Retrieve service identity, build/start timestamps, and runtime resource counters.
GET /api/v1/notes/health
The Hoody Notes service provides collaborative notebooks, documents, and real-time editing capabilities. This page documents the HTTP endpoints exposed by the service for health monitoring and runtime introspection.
Health Check
Retrieve service identity, build/start timestamps, and runtime resource counters.
GET /api/v1/notes/health
GET /api/v1/notes/healthReturns a standardized health payload with service identity, build/start timestamps, resource counters (memory, fds), process id, peer address, and the caller user-agent. Use this endpoint to verify service availability and inspect runtime metadata.
This endpoint takes no parameters.
curl https://abc123-def456-notes-1.us-east-1.containers.hoody.icu/api/v1/notes/healthawait client.notes.health.check(){ "status": "ok", "service": "notes", "built": "2024-01-15T08:00:00.000Z", "started": "2024-01-15T12:00:00.000Z", "memory": { "rss": 52428800, "heap": 41943040 }, "fds": 128, "pid": 12345, "ip": "10.0.0.42", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"}The memory object reports the resident set size (rss) and heap usage in bytes. The fds field exposes the open file descriptor count when available. built and userAgent may be null if the corresponding metadata was not captured at runtime.