Netmon Docs · Product Guide

API & Integrationsv7.0.20

The same API the web interface runs on, opened to your own tooling: PowerShell cmdlets, live capture into Wireshark, and AI assistants that speak the Model Context Protocol — every token scoped, every call permission-checked.

Everything the web interface shows is also reachable programmatically. The appliance exposes a REST API guarded by per-user tokens, and ships ready-made clients for the three integrations administrators ask for first: PowerShell, Wireshark, and AI assistants speaking the Model Context Protocol (MCP).

Access to all of it is gated by the API / MCP Access permission, and every token acts as the user who created it — a token never grants more than its owner could do in the browser, and tag scoping follows it.

Full endpoint reference

This page introduces the API and its ready-made clients. For per-endpoint detail — every route, its parameters, permissions, and response shape — see the Netmon 7 API Reference.

Personal access tokens

For scripts and integrations that need a credential, mint a personal access token from your account. The token is displayed once at creation — store it in your secrets manager, not a wiki — and presents as a standard Bearer token:

curl -H "Authorization: Bearer <token>" https://your-netmon/api/devices

Tokens are scoped at creation to functional areas (devices, logs, alerts, reports, tools, capture, and so on), so a dashboard script can hold a read-only devices token rather than your whole account. Revoke tokens individually when scripts retire.

Sign-in for installed clients

Interactive clients — the PowerShell module, the Wireshark integration, MCP desktop clients — use a browser sign-in rather than a pasted secret: the client shows a short code, you approve it in the Netmon web interface, and the client receives its own scoped credential. Approval happens against your normal account, with your normal permissions; consent shows which client is asking and for what scope.

The PowerShell module

The Netmon PowerShell module (PowerShell 7+) wraps the API in cmdlets:

Connect-Netmon https://your-netmon.example.com
Get-NetmonDevice | Where-Object status -eq 'down'
Test-NetmonMTR -Target 203.0.113.9

Connect-Netmon runs the browser sign-in (or accepts -Token for unattended use). The cmdlets cover the daily objects — devices, logs, alerts, probes — and compose like any PowerShell pipeline, which makes the module the natural bridge into your existing automation.

Wireshark integration

The Wireshark package (from System → System Settings → Downloadables) adds Netmon to Wireshark’s capture-interface list on your workstation. After a one-time sign-in, starting a capture on that interface streams packets from an appliance capture session live into Wireshark — the appliance’s vantage point, your desk’s tooling. See Packet Capture for the capture semantics; the integration honors the same permission and concurrency rules.

AI assistants (MCP)

The appliance speaks the Model Context Protocol, the open standard that lets AI assistants use external systems. Connect an MCP-capable client — Claude Desktop uses Netmon’s extension bundle — sign in with the same browser approval, and the assistant can query your monitoring through the same scoped, permission-checked API: “which devices went down this week and what did they log first?” becomes a question rather than a query-writing exercise.

The assistant holds a token like any other client: scoped at consent, acting as you, revocable at any time.

Important

Treat every token as a credential equal to its scope. Prefer narrow scopes, prefer the browser sign-in over long-lived pasted tokens for anything interactive, and revoke what you no longer use. The token list — like the rest of the product — is only as clean as its last audit.