API response model reference

Generated file — do not edit by hand. Regenerate from the repo root with CGO_ENABLED=0 go run scripts/gen-response-models-md.go.

One page per module, one row per (method, path) the daemon serves — the same inventory as routes.md. The Response model column on each page is derived from each handler’s Go response type: the generator traces the handler to its success-path write (api.WriteMessage / api.WriteDoc, the module writer helpers, or a direct JSON encode) and prints the static type of the payload, so the column cannot drift from the code. Structs whose only JSON field is message or data render as the two wire envelopes MethodResponse[T] ({“message”: T}) and DocResponse[T] ({“data”: T}) from core/api/respond.go. Envelopes compose rather than flatten: the writer contributes one level and the handler’s payload expression may nest more, so a handler that hands api.WriteMessage a {"data": …} payload puts {"message":{"data": T}} on the wire and is documented as the nested MethodResponse[DocResponse[T]] — the exact chain the generated API client unwraps.

Origin handler means the model was derived from the handler source. annotation marks routes whose response is not a derivable JSON body (WebSocket upgrades, SSE/raw streams, proxies, file downloads); their entries are maintained in scripts/response-model-annotations.yaml and the generator fails when a route is missing from both sources or an annotation goes stale. Handlers with several success shapes list them joined with “or”. {a, b} denotes an ad-hoc JSON object with exactly those keys.

Total: 346 routes — 319 derived from handlers, 27 annotated.

• app — 28 routes
• audit — 3 routes
• auth — 6 routes
• backup — 38 routes
• backup_mount_router — 19 routes
• ca — 6 routes
• capabilities — 1 route
• clone — 3 routes
• cluster — 29 routes
• config — 4 routes
• connections — 6 routes
• cron — 1 route
• dns — 6 routes
• docker — 13 routes
• doctor — 2 routes
• events — 3 routes
• export — 3 routes
• forward — 2 routes
• health — 3 routes
• internal_rpc — 1 route
• internal_stacks — 5 routes
• job — 7 routes
• leader — 2 routes
• license — 7 routes
• logs — 6 routes
• mcp — 4 routes
• metrics — 2 routes
• nebula — 10 routes
• network — 5 routes
• node — 7 routes
• notification — 1 route
• portforward — 1 route
• quota — 6 routes
• repo — 8 routes
• retention — 5 routes
• schedule — 8 routes
• search — 1 route
• shell — 4 routes
• stack — 9 routes
• storage — 34 routes
• supportbundle — 1 route
• sysroutes — 2 routes
• task — 4 routes
• tenant — 4 routes
• user — 8 routes
• vault — 18 routes

Field tables for every named struct a response model references live in payload-shapes.md.