CachePuppy
API reference

HTTP routes

JSON APIs, admin topic routes, and process-level health checks.

Application JSON (/api)

MethodPathControllerPurpose
GET/api/healthHealthController#showNode plus cluster visibility JSON.
POST/api/cache/setdataCacheController#setdataSet cache key with optional ttl_ms.
POST/api/cache/getdataCacheController#getdataRead cache key.
POST/api/cache/deletedataCacheController#deletedataDelete cache key.

Server admin topic API (/api/server/v1)

MethodPathPurpose
PUT/topics/:topic/stateReplace shared topic state JSON.
GET/topics/:topic/stateRead topic state plus meta.
DELETE/topics/:topicClose topic / stop owner.
POST/topics/:topic/messagesFan-out publish (202).
GET/topics/:topic/presencePresence snapshot.

Process health (outside /api)

MethodPathPurpose
GET/healthzLiveness — process is up.
GET/readyzReadiness — quorum satisfied.

Implementation pointer

See cachepuppy_core/lib/cachepuppy_core_web/router.ex for the authoritative route table wired today.

On this page