Skip to content

API Reference ​

MeshMonitor exposes a REST API for interacting with your mesh network programmatically. The interactive Swagger UI below is the canonical reference.

Quick start ​

  1. Start MeshMonitor (locally or access your deployment).
  2. Open Settings β†’ API Tokens and generate a token.
  3. Click Authorize in the Swagger UI below and paste the token.
  4. Expand any endpoint and click Try it out to make live calls against your instance.

Same docs, two places

The Swagger UI rendered below is identical to the one served by your running MeshMonitor at /api/v1/docs. Use either β€” they read from the same OpenAPI spec.

Versioning ​

All endpoints are prefixed with /api/v1/. When endpoint shapes change within v1, the old shape is kept working for at least one release with a deprecation Warning header before removal; larger overhauls would ship as /api/v2/.

4.13 shape change: mesh-data resources (nodes, messages, channels, telemetry, traceroutes, network, packets, status, position-history) are now served under /api/v1/sources/{sourceId}/.... The old root-scoped v1 paths (/api/v1/nodes?sourceId=... etc.) still respond with a Warning: 299 header but are removed in 4.14. Use "default" as {sourceId} to target the primary source. See the v1 source-scoping announcement for the full migration guide, or REST_API.md in the repository for the endpoint-by-endpoint table.

Interactive documentation ​