Reference

Reference pages document stable APIs, protocol fields, errors, and security boundaries. This section is a factual manual for system behavior, not a tutorial.

Access and interfaces

• Auth: admin sessions, download tokens, MCP tokens, and source guard rules.
• API: REST APIs, client binding, internal EMQX callbacks, and development endpoints.
• Realtime: SSE stream, event frame format, and frontend subscription behavior.
• MCP: MCP resources, tools, write confirmations, and audit behavior.

Protocols and data

• MQTT Messages: client status, control commands, ACKs, and topic authorization.
• Client Lifecycle: dynamic node binding, online state, disconnects, reset, and page transitions.
• Downloads: client artifacts, config packages, snapshot exports, and short-lived URLs.
• Snapshots: application-level snapshot contents, encryption, and restore boundaries.
• Data Model: configs, nodes, peer links, runtime state, and sync state.
• Protocols: WireGuard, AmneziaWG 2.0, and AWG parameter rules.
• Quick Mesh: gateway, full mesh, and Free Mesh generation rules.

Runtime boundaries

• Security: public source guard, MCP boundaries, high-risk operations, and data protection.
• Environment: deployment environment variables.
• Errors: unified error responses and common business error codes.