Netmon Docs · API Reference

Complete Endpoint Indexv7.0.20

Every endpoint documented in this guide, one row apiece, grouped by resource area and sorted by path — the whole reference in one Ctrl-F-able page.

This page lists every endpoint documented in this guide, grouped by resource area and sorted by path within each. The Permission column is the gate the calling user must hold; (public) endpoints need no token, (authenticated) endpoints accept any valid token, and (web/public) endpoints are reached through a browser session rather than a bearer token. This index is generated from the appliance’s own route table — every documented endpoint appears here.

On this page

Authentication
Devices
Device Trackers
Agents
NetFlow & VNE
Logs
Alerting
Legacy Alerts
Reports
URL Monitoring
Network Tools
Packet Capture
System Settings
Data Maintenance
Super-Admin
Users & Access
Terminal

Authentication

Method	Path	Permission
GET	`/.well-known/oauth-authorization-server`	(web/public)
GET	`/.well-known/oauth-protected-resource`	(web/public)
POST	`/api/ensureWebSession`	(authenticated)
POST	`/api/information`	(public)
POST	`/api/login`	(web/public)
POST	`/api/logout`	(authenticated)
POST	`/api/oauth/device/authorize`	(public)
POST	`/api/oauth/device/token`	(public)
POST	`/api/oauth/token/introspect`	(public)
POST	`/api/oauth/token/refresh`	(public)
POST	`/api/oauth/token/revoke`	(authenticated)
GET	`/api/tokens`	`api`
POST	`/api/tokens`	`api`
DELETE	`/api/tokens/{id}`	`api`
GET	`/api/users/{userId}/tokens`	`users`
POST	`/api/users/{userId}/tokens/revoke-all`	`users`
DELETE	`/api/users/{userId}/tokens/{id}`	`users`
GET	`/auth/authorize`	(web/public)
POST	`/auth/authorize`	(web/public)
GET	`/auth/device`	(web/public)
POST	`/auth/device`	(web/public)
GET	`/auth/device-code.js`	(web/public)
POST	`/auth/register`	(web/public)
POST	`/auth/token`	(web/public)

Devices

Method	Path	Permission
POST	`/api/addEditCredential`	`write_devices`
POST	`/api/addWidgetToDash`	`devices`
GET	`/api/agent/download`	Bearer or signed URL
POST	`/api/deleteDevice`	`write_devices`
POST	`/api/deleteDeviceLayouts`	`devices`
GET	`/api/device/profiles`	`devices\|overwatch\|write_devices`
POST	`/api/device/set`	`write_devices`
DELETE	`/api/device/{device}`	`devices` + `write_devices`
GET	`/api/device/{device}`	`devices`
POST	`/api/device/{device}/recrawl`	`devices` + `write_devices`
GET	`/api/device/{device}/stats`	`devices`
DELETE	`/api/device/{device}/tags`	`devices` + `write_devices`
GET	`/api/device/{device}/tags`	`devices`
POST	`/api/device/{device}/tags`	`devices` + `write_devices`
GET	`/api/devices`	`devices\|overwatch`
GET	`/api/devices/{deviceId}/hyperv`	`devices`
GET	`/api/devices/{deviceId}/hyperv/vm/{vmGuid}/cpu`	`devices`
GET	`/api/getArpScanStatus`	`devices`
POST	`/api/getArpTable`	`devices`
GET	`/api/getCredentials`	`write_devices`
GET	`/api/getDashboards`	(authenticated)
GET	`/api/getDeviceTrackers`	`devices`
POST	`/api/getDevicesPending`	`write_devices`
POST	`/api/getLatencyTracker`	`devices`
GET	`/api/getNavData`	(authenticated)
POST	`/api/getRecentHost`	`devices`
POST	`/api/getTCPTracker`	`devices`
GET	`/api/getTopBandwidth/{mins}`	`devices`
POST	`/api/hidePendingDevice`	`write_devices`
POST	`/api/importPending`	`write_devices`
POST	`/api/removePendingDevice`	`write_devices`
POST	`/api/setCustomHostname`	`write_devices`
POST	`/api/setDashboards`	(authenticated)
POST	`/api/setDeviceLayouts`	`devices`
POST	`/api/setDevicePinnedWidgets`	`devices`
GET	`/api/tags`	`devices\|overwatch\|write_devices`
POST	`/api/testSnmp`	`write_devices`
POST	`/api/updatePendingDeviceField`	`write_devices`
POST	`/api/updatePendingDeviceTags`	`write_devices`

Device Trackers

Method	Path	Permission
GET	`/api/device/{id}/disks`	`write_devices`
GET	`/api/device/{id}/interfaces`	`write_devices`
GET	`/api/device/{id}/interfaces/connections`	`write_devices`
GET	`/api/device/{id}/latency`	`write_devices`
GET	`/api/device/{id}/ports`	`write_devices`
GET	`/api/disk/all`	`write_devices`
POST	`/api/disk/delete`	`write_devices`
GET	`/api/disk/get/{id}`	`write_devices`
POST	`/api/disk/set`	`write_devices`
POST	`/api/disk/stats`	`write_devices`
GET	`/api/disk/stats/{id}`	`write_devices`
GET	`/api/interfaces/all`	`write_devices`
POST	`/api/interfaces/delete`	`write_devices`
GET	`/api/interfaces/get/{id}`	`write_devices`
POST	`/api/interfaces/set`	`write_devices`
GET	`/api/interfaces/stats/{id}`	`write_devices`
POST	`/api/interfaces/toggleupdown`	`write_devices`
GET	`/api/latency/all`	`write_devices`
POST	`/api/latency/delete`	`write_devices`
GET	`/api/latency/get/{id}`	`write_devices`
POST	`/api/latency/set`	`write_devices`
POST	`/api/latency/stats`	`write_devices`
GET	`/api/latency/stats/{id}`	`write_devices`
POST	`/api/oid/delete`	`write_devices`
GET	`/api/oid/get/{id}`	`write_devices`
POST	`/api/oid/set`	`write_devices`
GET	`/api/port/all`	`write_devices`
POST	`/api/port/delete`	`write_devices`
GET	`/api/port/get/{id}`	`write_devices`
POST	`/api/port/set`	`write_devices`
GET	`/api/port/stats/{id}`	`write_devices`
POST	`/api/protocol/delete`	`write_devices`
POST	`/api/protocol/get`	`write_devices`
POST	`/api/protocol/set`	`write_devices`
POST	`/api/service/delete`	`write_devices`
GET	`/api/service/get/{id}`	`write_devices`
GET	`/api/service/getAll/{deviceId}`	`write_devices`
POST	`/api/service/set`	`write_devices`
GET	`/api/service/statsOf/{id}`	`write_devices`

Agents

Method	Path	Permission
GET	`/api/agent-tokens`	`agentadmin`
POST	`/api/agent-tokens`	`agentadmin`
DELETE	`/api/agent-tokens/{id}`	`agentadmin`
GET	`/api/agent-tokens/{id}`	`agentadmin`
POST	`/api/agent/adopt-by-token`	`devices` + `write_devices`
POST	`/api/agent/checkin`	(public)
POST	`/api/agent/enroll`	(public)
POST	`/api/generateDiskUsage`	`devices`
POST	`/api/getAgentID`	`devices\|write_devices`
POST	`/api/getDetailedDiskUsage`	`devices`
POST	`/api/getDeviceProcesses`	`devices`
POST	`/api/getDeviceServices`	`devices`
POST	`/api/getFolderUsageFromPath`	`devices`
POST	`/api/tryDeleteFile`	`agentadmin`
POST	`/api/tryDeleteFolder`	`agentadmin`

NetFlow & VNE

Method	Path	Permission
GET	`/api/aggnetflow/list`	`vne`
GET	`/api/netflow/filters`	`vne`
POST	`/api/netflow/filters`	`vne`
POST	`/api/netflow/filters/toggle/{filterId}`	`vne`
DELETE	`/api/netflow/filters/{filterId}`	`vne`
GET	`/api/netflow/list`	`vne`

Logs

Method	Path	Permission
GET	`/api/eve/filters`	`logs`
POST	`/api/eve/filters`	`logs`
POST	`/api/eve/filters/toggle/{filterId}`	`logs`
DELETE	`/api/eve/filters/{filterId}`	`logs`
GET	`/api/eve/get/{event}`	`logs`
GET	`/api/eve/list`	`logs`
GET	`/api/eve/sevSum`	`logs`
GET	`/api/eventlog/filters`	`logs`
POST	`/api/eventlog/filters`	`logs`
POST	`/api/eventlog/filters/toggle/{filterId}`	`logs`
DELETE	`/api/eventlog/filters/{filterId}`	`logs`
GET	`/api/eventlog/list`	`logs`
GET	`/api/eventlog/queries`	`write_devices`
GET	`/api/eventlog/sevSum`	`logs`
GET	`/api/eventlog/trackers`	`write_devices`
POST	`/api/eventlog/trackers`	`write_devices`
DELETE	`/api/eventlog/trackers/{id}`	`write_devices`
GET	`/api/syslog/config/{deviceId}`	`write_devices`
POST	`/api/syslog/config/{deviceId}`	`write_devices`
GET	`/api/syslog/filters`	`logs`
POST	`/api/syslog/filters`	`logs`
POST	`/api/syslog/filters/toggle/{filterId}`	`logs`
DELETE	`/api/syslog/filters/{filterId}`	`logs`
GET	`/api/syslog/list`	`logs`
GET	`/api/syslog/sevSum`	`logs`

Alerting

Method	Path	Permission
GET	`/api/alert-classes`	`alerts`
GET	`/api/alerts`	`alerts`
POST	`/api/alerts`	`alerts`
GET	`/api/alerts/maintenance-windows`	`alerts`
POST	`/api/alerts/maintenance-windows`	`alerts`
POST	`/api/alerts/maintenance-windows/delete`	`alerts`
GET	`/api/alerts/templates`	`alerts`
DELETE	`/api/alerts/{id}`	`alerts`
GET	`/api/alerts/{id}`	`alerts`
PUT	`/api/alerts/{id}`	`alerts`
POST	`/api/alerts/{id}/toggle`	`alerts`
GET	`/api/alerts/{source}/{id}/maintenance-windows`	`alerts`
POST	`/api/alerts/{source}/{id}/maintenance-windows/attach`	`alerts`
POST	`/api/alerts/{source}/{id}/maintenance-windows/detach`	`alerts`
POST	`/api/alerts/{source}/{id}/maintenance-windows/sync`	`alerts`
GET	`/api/alerts/{source}/{id}/router-config`	`alerts`
POST	`/api/alerts/{source}/{id}/router-config`	`alerts`
GET	`/api/email-templates`	`alerts`
GET	`/api/email-templates/classes`	`alerts`
GET	`/api/email-templates/{id}`	`alerts`
PUT	`/api/email-templates/{id}`	`alerts`
POST	`/api/email-templates/{id}/restore`	`alerts`
GET	`/api/legacy-handlers`	`alerts`
GET	`/api/outlet-templates`	`alerts`
POST	`/api/outlet-templates`	`alerts`
DELETE	`/api/outlet-templates/{id}`	`alerts`
GET	`/api/outlet-templates/{id}`	`alerts`
PUT	`/api/outlet-templates/{id}`	`alerts`
GET	`/api/outlets`	`alerts`
POST	`/api/outlets`	`alerts`
POST	`/api/outlets/test`	`alerts`
GET	`/api/outlets/test/{kind}/{id}`	`alerts`
DELETE	`/api/outlets/{id}`	`alerts`
GET	`/api/outlets/{id}`	`alerts`
PUT	`/api/outlets/{id}`	`alerts`
GET	`/api/routing-rules`	`alerts`
POST	`/api/routing-rules`	`alerts`
DELETE	`/api/routing-rules/{id}`	`alerts`
GET	`/api/routing-rules/{id}`	`alerts`
PUT	`/api/routing-rules/{id}`	`alerts`

Legacy Alerts

Method	Path	Permission
GET	`/api/alert-history/{id}/log`	`alerts`
POST	`/api/deleteAlert`	`alerts`
GET	`/api/device/{device}/alert-history`	`alerts`
GET	`/api/getAlertHistory`	`alerts`
POST	`/api/getAlerts`	`alerts`
POST	`/api/setAlert`	`alerts`
POST	`/api/setAlerts`	`alerts`

Reports

Method	Path	Permission
GET	`/api/allDisks`	`reports`
GET	`/api/allInterfaces`	`reports`
POST	`/api/deleteReport`	`reports`
GET	`/api/deviceReport`	`reports`
GET	`/api/diskTracker`	`reports`
GET	`/api/getAllDisks`	`reports`
GET	`/api/getAllHelpers`	`reports`
GET	`/api/getAllInterfaces`	`reports`
GET	`/api/getAllLatencys`	`devices`
GET	`/api/getAllSources`	`reports`
GET	`/api/getAllTCPs`	`reports`
GET	`/api/getAllTrackers`	`reports`
GET	`/api/getNetflowInterfaces`	`reports`
GET	`/api/getProtocolInterfaces`	`reports`
POST	`/api/getReport`	`reports`
GET	`/api/getReportCache`	`reports`
GET	`/api/interfaceTracker`	`reports`
GET	`/api/latencyTracker`	`reports`
GET	`/api/networkActivity`	`reports`
GET	`/api/networkProtocol`	`reports`
GET	`/api/networkTraffic`	`reports`
GET	`/api/performanceTracker`	`reports`
GET	`/api/portReport`	`reports`
GET	`/api/tcpTracker`	`reports`
GET	`/api/upDown`	`reports`
POST	`/api/updateReport`	`reports`
GET	`/api/urlTracker`	`reports`

URL Monitoring

Method	Path	Permission
POST	`/api/deleteUrl`	`urls`
GET	`/api/getAllUrls`	`urls`
GET	`/api/getUrls`	`urls`
POST	`/api/saveUrl`	`urls`

Network Tools

Method	Path	Permission
GET	`/api/SSEgetMTRInfo/{mtrTarget}`	`tools`
GET	`/api/SSEgetPingInfo/{pingTarget}`	`tools`
GET	`/api/getLastWalk/{device}`	`tools`
POST	`/api/getPingInfo/{pingTarget}`	`tools`
GET	`/api/getPortServiceNames`	`tools`
POST	`/api/getPortscanInfo`	`tools`
POST	`/api/getSNMPWalkInfo/{target}`	`tools`
GET	`/api/getSpeedTestHistory`	`tools`
POST	`/api/getSpeedTestInfo`	`tools`
POST	`/api/getTracerouteInfo/{traceTarget}`	`tools`
POST	`/api/iperf/client/run`	`tools`
POST	`/api/iperf/server/start`	`tools`
GET	`/api/iperf/server/status`	`tools`
POST	`/api/iperf/server/stop`	`tools`
DELETE	`/api/speedtest-history/{id}`	`tools`
GET	`/api/tools/geoip/{ip}`	`tools`
GET	`/api/tools/whois/{ip}`	`tools`

Packet Capture

Method	Path	Permission
GET	`/api/captures`	`capture`
POST	`/api/captures`	`capture`
GET	`/api/captures/interfaces`	`capture`
DELETE	`/api/captures/{id}`	`capture`
GET	`/api/captures/{id}`	`capture`
GET	`/api/captures/{id}/chunks`	`capture`
GET	`/api/captures/{id}/download.pcapng`	`capture`
POST	`/api/captures/{id}/stop`	`capture`

System Settings

Method	Path	Permission
GET	`/api/backups`	`system`
DELETE	`/api/backups/{filename}`	`system`
GET	`/api/backups/{filename}`	`system`
POST	`/api/createFullBackup`	`system`
POST	`/api/createHostname`	`system`
POST	`/api/createProtocols`	`system`
POST	`/api/deleteHost`	`system`
POST	`/api/deleteLocalnet`	`system`
POST	`/api/deleteProtocol`	`system`
GET	`/api/downloadLogs`	`system`
GET	`/api/downloadables`	`system`
GET	`/api/downloadables/{category}/{filename}`	`system`
POST	`/api/extractCertificate`	`sa`
GET	`/api/getAlertTemplates`	`system`
GET	`/api/getCertificate`	`sa`
GET	`/api/getHostname`	`system`
POST	`/api/getHostnames`	`system`
GET	`/api/getLicenseInfo`	`system`
GET	`/api/getLocalnets`	`system`
POST	`/api/getNetworkInfo`	`system`
POST	`/api/getProtocols`	`system`
POST	`/api/getProtocolsForSingle`	`system`
GET	`/api/getTimeSettings`	`system`
GET	`/api/manageNetmonServices`	`system`
POST	`/api/procmon`	`system`
POST	`/api/resetDiscoveryTs`	`system`
POST	`/api/restartNetmon`	`system`
POST	`/api/saveCertificate`	`sa`
POST	`/api/setAlertTemplate`	`system`
POST	`/api/setHostname`	`system`
POST	`/api/setNetworkInfo`	`system`
POST	`/api/setTimeSettings`	`system`
POST	`/api/smtpSettings`	`system`
GET	`/api/system/health`	`system`
POST	`/api/system/health/cron-reenable`	`system`
POST	`/api/updateHostname`	`system`
POST	`/api/updateLocalnet`	`system`
POST	`/api/updateProtocol`	`system`
POST	`/api/validateLicense`	`system`
POST	`/api/verifyCertificate`	`sa`

Data Maintenance

Method	Path	Permission
GET	`/api/daemon/{identifier}`	`sa`
POST	`/api/daemon/{id}/config`	`sa`
POST	`/api/daemon/{id}/start`	`sa`
POST	`/api/deleteOldPartitions`	`system`
POST	`/api/deletePartition`	`system`
GET	`/api/getAvailableTablespaces`	`system`
GET	`/api/getPartitionedTables`	`system`
GET	`/api/getRetentionPolicy`	`system`
POST	`/api/getTableCronSchedule`	`system`
POST	`/api/getTablePartitions`	`system`
POST	`/api/getTableTablespace`	`system`
POST	`/api/moveTableToTablespace`	`system`
POST	`/api/rotatePartition`	`system`
POST	`/api/setRetentionPolicy`	`system`
POST	`/api/updateTableCronSchedule`	`system`

Super-Admin

Method	Path	Permission
GET	`/api/ldap/config`	`sa`
POST	`/api/ldap/config`	`sa`
GET	`/api/ldap/group-tags`	`sa`
POST	`/api/ldap/group-tags`	`sa`
GET	`/api/ldap/groups`	`sa`
GET	`/api/ldap/mappings`	`sa`
POST	`/api/ldap/mappings`	`sa`
POST	`/api/ldap/mappings/bulk`	`sa`
DELETE	`/api/ldap/mappings/{id}`	`sa`
POST	`/api/ldap/sync`	`sa`
POST	`/api/ldap/test`	`sa`
GET	`/api/oauth/clients/pending`	`system`
DELETE	`/api/oauth/clients/{clientId}`	`system`
POST	`/api/oauth/clients/{clientId}/approve`	`system`
GET	`/api/osUpgrade/info`	`sa`
POST	`/api/osUpgrade/install`	`sa`
POST	`/api/osUpgrade/start`	`sa`
POST	`/api/osUpgrade/stop`	`sa`

Users & Access

Method	Path	Permission
POST	`/api/confirmMfa`	`users`
POST	`/api/createUser`	`users`
POST	`/api/deleteUser`	`users`
POST	`/api/disableMfa`	`users`
POST	`/api/generateMfa`	`users`
GET	`/api/getPermissions`	(authenticated)
GET	`/api/getUsers`	(authenticated)
GET	`/api/me`	(authenticated)
POST	`/api/saveUser`	`users`

Terminal

Method	Path	Permission
GET\|POST\|PUT\|PATCH\|DELETE\|OPTIONS	`/api/term/proxy/{path?}`	`system`

PreviousPermissions & Scopes NextGuide home