Skip to main content

Module api

Module api 

Source
Expand description

REST API handlers for the web dashboard.

All /api/* routes require bearer token authentication (PairingGuard).

Structs§

AuditQuery
CronAddBody
CronPatchBody
CronRunsQuery

Functions§

handle_api_audit
GET /api/audit — recent audit trail events
handle_api_audit_verify
GET /api/audit/verify — verify audit chain integrity
handle_api_channel_events
POST /api/channel-events — accept a structured channel event from the operator (or any internal service) and broadcast it to all connected SSE / WebSocket subscribers via event_tx.
handle_api_channels
GET /api/channels — returns detailed channel information for the dashboard.
handle_api_cli_tools
GET /api/cli-tools — discovered CLI tools
handle_api_config_get
GET /api/config — current config (api_key masked)
handle_api_config_put
PUT /api/config — update config from TOML body
handle_api_cost
GET /api/cost — cost summary
handle_api_cron_add
POST /api/cron — add a new cron job
handle_api_cron_delete
DELETE /api/cron/:id — remove a cron job
handle_api_cron_list
GET /api/cron — list cron jobs
handle_api_cron_patch
PATCH /api/cron/:id — update an existing cron job
handle_api_cron_runs
GET /api/cron/:id/runs — list recent runs for a cron job
handle_api_cron_settings_get
GET /api/cron/settings — return cron subsystem settings
handle_api_cron_settings_patch
PATCH /api/cron/settings — update cron subsystem settings
handle_api_doctor
POST /api/doctor — run diagnostics
handle_api_health
GET /api/health — component health snapshot
handle_api_integrations
GET /api/integrations — list all integrations with status
handle_api_integrations_settings
GET /api/integrations/settings — return per-integration settings (enabled + category)
handle_api_node_invoke
POST /api/nodes/:node_id/invoke — invoke a capability on a specific node
handle_api_nodes
GET /api/nodes — list connected nodes and their capabilities
handle_api_session_delete
DELETE /api/sessions/{id} — delete a gateway session
handle_api_session_messages
GET /api/sessions/{id}/messages — load persisted gateway WebSocket chat transcript
handle_api_session_rename
PUT /api/sessions/{id} — rename a gateway session
handle_api_session_state
GET /api/sessions/{id}/state — get session state
handle_api_sessions_list
GET /api/sessions — list gateway sessions
handle_api_sessions_running
GET /api/sessions/running — list sessions currently in “running” state
handle_api_status
GET /api/status — system status overview
handle_api_tools
GET /api/tools — list registered tool specs
handle_claude_code_hook
POST /hooks/claude-code — receives HTTP hook events from Claude Code sessions spawned by [ClaudeCodeRunnerTool].