API reference
HTTP routes
JSON APIs, admin topic routes, and process-level health checks.
Application JSON (/api)
| Method | Path | Controller | Purpose |
|---|---|---|---|
GET | /api/health | HealthController#show | Node plus cluster visibility JSON. |
POST | /api/cache/setdata | CacheController#setdata | Set cache key with optional ttl_ms. |
POST | /api/cache/getdata | CacheController#getdata | Read cache key. |
POST | /api/cache/updatedata | CacheController#updatedata | Patch cache value (shallow merge). |
POST | /api/cache/deletedata | CacheController#deletedata | Delete cache key. |
POST | /api/workflows | WorkflowController#create | Create a workflow. |
GET | /api/workflows/:id | WorkflowController#show | Read workflow state (steps + groups). |
POST | /api/workflows/:id/steps | StepController#add_step | Add a sequential step. |
POST | /api/workflows/:id/parallel | StepController#add_parallel | Add a parallel branch group. |
POST | /api/workflows/:id/merge | StepController#add_merge | Add a merge step for branches. |
POST | /api/workflows/:id/resume | StepController#resume | Resume from a specific failed step. |
POST | /api/workflows/:id/end | StepController#end_workflow | End workflow execution. |
Server admin topic API (/api/server/v1)
| Method | Path | Purpose |
|---|---|---|
PUT | /topics/:topic/state | Replace shared topic state JSON. |
GET | /topics/:topic/state | Read topic state plus meta. |
DELETE | /topics/:topic | Close topic / stop owner. |
POST | /topics/:topic/messages | Fan-out publish (202). |
GET | /topics/:topic/presence | Presence snapshot. |
Process health (outside /api)
| Method | Path | Purpose |
|---|---|---|
GET | /healthz | Liveness — process is up. |
Implementation pointer
See cachepuppy_core/lib/cachepuppy_core_web/router.ex for the authoritative route table wired today.