ntopng Documentation
ntopng can be used in combination with other ntop tools. Documentation to use ntopng with other tools is the object of this section.
User's Guide
- What is ntopng
- Available Versions & Licensing
- Installation
- How to Start ntopng
- Command Line Options
- User Interface Guide
- Using ntopng with ntop Tools
- Industrial Monitoring
- Quality of Experience (QoE)
- Operating ntopng on large networks
- Flows Dump
- Advanced Features
- Third-Party Integrations
- Performance and Hardware Sizing
- FAQ
- Licenses
- What to Save: Timeseries, Flows, pcaps
- Maximum Number of Interfaces
- Cannot Login into the GUI
- Too many failed authentication attempts
- Reset ntopng Preferences
- How Can I Troubleshoot SNMP ?
- How can I monitor the sites visited by an host?
- How do I know who is using most of my bandwidth?
- How can I associate an hostname to a certain category?
- How can I estimate the disk space required by ntopng?
- Cannot see data in Grafana
- Permission denied errors
Developer's Guide
- Developers
- API Documentation
- RESTful API
- 1. RESTful API v2 Specification
- 1.1. Authentication
- 1.2. Request Format
- 1.3. Response Format
- 1.4. API
- 1.4.1. Interfaces
- 1.4.2. Hosts
- 1.4.3. Alerts
- 1.4.4. Flows
- 1.4.5. PCAP
- 1.4.6. Users
- 1.4.7. Infrastructures
- 1.4.8. Health
- 1.4.9. Configurations
- 1.4.10. Vulnerability Scan
- 1.4.11. Host
- 1.4.12. SNMP
- 1.4.13. All
- 1.4.14. Observation Point
- 1.4.15. Pools
- 1.4.16. Traffic
- 1.4.17. Timeseries
- 1.4.18. Peers
- 1.4.19. Top
- 1.4.20. System
- 1.4.21. Sites
- 1.4.22. Maps
- 1.4.23. User
- 1.4.24. Checks
- 1.4.25. Notification Endpoints
- 1.4.26. Notification Recipients
- 1.4.27. L7 Application Categories
- 1.4.28. Configuration
- 1.4.29. Active Monitoring
- 1.4.30. Notifications
- 1.4.31.
- 2. Examples v2
- 3. RESTful API v1 Specification
- 3.1. Authentication
- 3.2. Request Format
- 3.3. Response Format
- 3.4. API
- 3.4.1. Interfaces
- 3.4.2. Hosts
- 3.4.3. Alerts
- 3.4.4. Flows
- 3.4.5. PCAP
- 3.4.6. Users
- 3.4.7. Infrastructures
- 3.4.8. L4 Protocols
- 3.4.9. L7 Application Protocols
- 3.4.10. L7 Application Categories
- 3.4.11. SNMP
- 3.4.12. Pools
- 3.4.13. Notification Recipients
- 3.4.14. Notification Endpoints
- 3.4.15. All
- 3.4.16. Active Monitoring
- 3.4.17. Notifications
- 3.4.18.
- 4. Examples v1
- 1. RESTful API v2 Specification
- Lua API
- 1. ntop Lua Object
- 1.1. Cache API
- 1.2. Prefs API
setPref()
getPref()
getPrefs()
flushCache()
listIndexCache()
lpushCache()
rpushCache()
lpopCache()
rpopCache()
lremCache()
ltrimCache()
lrangeCache()
llenCache()
setMembersCache()
delMembersCache()
getMembersCache()
getHashCache()
setHashCache()
delHashCache()
getHashKeysCache()
getHashAllCache()
getKeysCache()
- 1.3. Filesystem API
- 1.4. Network API
- 1.5. Users API
- 1.6. Misc API
getDirs()
getInfo()
getUptime()
getHttpPrefix()
getRandomCSRFValue()
isShuttingDown()
getLocalNetworks()
addLocalNetwork()
setMacDeviceType()
reloadHostPools()
getNetworkNameById()
getNetworkIdByName()
getHostInformation()
systemHostStat()
syslog()
setLoggingLevel()
traceEvent()
verboseTrace()
gettimemsec()
getticks()
gettickspersec()
isLoginDisabled()
hasVLANs()
hasGeoIP()
isWindows()
msleep()
getMacManufacturer()
md5()
exec_sql_query()
resetStats()
isPro()
isEnterpriseM()
isEnterpriseL()
isPackage()
getStartupEpoch()
serviceRestart()
matchCustomCategory()
getTLSVersionName()
bitmapIsSet()
bitmapSet()
bitmapClear()
setnDPIProtoCategory()
getnDPIProtoCategory()
ptreeClear()
ptreeInsert()
ptreeMatch()
isDeadlineApproaching()
getDeadline()
speedtest()
- 2. interface Lua Object
- 2.1. Hosts API
- 2.2. Flows API
- 2.3. Misc API
getIfNames()
getFirstInterfaceId()
getId()
select()
hasVLANs()
hasEBPF()
getActiveFlowsStats()
getMaxIfSpeed()
resetCounters()
resetStats()
getEndpoint()
isPacketInterface()
isDiscoverableInterface()
isBridgeInterface()
isPcapDumpInterface()
isView()
isViewed()
viewedBy()
isLoopback()
isRunning()
isIdle()
setInterfaceIdleState()
getStats()
getNetworksStats()
getNetworkStats()
getASesInfo()
getASInfo()
getCountriesInfo()
getVLANsList()
getVLANInfo()
getHostPoolsInfo()
resetPoolsQuotas()
getSFlowDevices()
getSFlowDeviceInfo()
captureToPcap()
isCaptureRunning()
stopRunningCapture()
getPodsStats()
getContainersStats()
- 2.4. MACs API
- 2.5. nDPI API
- 2.6. Dump API
- 3. Host Checks
- 4. Flow Checks
- 5. Interface Checks
- 6. Network Checks
- 1. ntop Lua Object
- Python API
- Prerequisites
- Installation
- Examples
- API
- Ntopng
Ntopng
- Interface
Interface
Interface.get_active_flows_paginated()
Interface.get_active_hosts()
Interface.get_active_l4_proto_flow_counters()
Interface.get_active_l7_proto_flow_counters()
Interface.get_address()
Interface.get_alert_severities_enum()
Interface.get_alert_types_enum()
Interface.get_alerts_counter_per_severity()
Interface.get_alerts_counter_per_type()
Interface.get_all_alerts()
Interface.get_broadcast_domains()
Interface.get_data()
Interface.get_dscp_stats()
Interface.get_historical()
Interface.get_host()
Interface.get_host_data()
Interface.get_l4_protocols_enum()
Interface.get_l7_application_category_enum()
Interface.get_l7_application_proto_enum()
Interface.get_l7_stats()
Interface.get_top_local_talkers()
Interface.get_top_remote_talkers()
- Host
Host
- Historical
Historical
Historical.get_active_monitoring_alerts()
Historical.get_alert_severity_counters()
Historical.get_alert_type_counters()
Historical.get_alerts()
Historical.get_alerts_stats()
Historical.get_flow_alerts()
Historical.get_flow_alerts_stats()
Historical.get_flows()
Historical.get_host_alerts()
Historical.get_host_timeseries()
Historical.get_host_timeseries_stats()
Historical.get_host_top_protocols()
Historical.get_interface_alerts()
Historical.get_interface_timeseries()
Historical.get_interface_timeseries_stats()
Historical.get_mac_alerts()
Historical.get_network_alerts()
Historical.get_snmp_alerts()
Historical.get_system_alerts()
Historical.get_timeseries()
Historical.get_timeseries_metadata()
Historical.get_timeseries_stats()
Historical.get_top_conversations()
Historical.get_topk_flows()
Historical.get_user_alerts()
- Timeseries API
- Alerts API
- Recording API
- recording_utils API
isSupportedZMQInterface()
getZMQProbeAddr()
isSupportedInterface()
isExternalProvidersReminderDismissed()
dismissExternalProvidersReminder()
isExtractionAvailable()
getN2diskInfo()
setLicense()
getExtInterfaces()
getPcapPath()
volumeInfo()
storageInfo()
createConfig()
isEnabled()
isExtractionEnabled()
isActive()
isExtractionActive()
parse_proc_stats()
stats()
smartStats()
getCurrentTrafficRecordingProviderTimelinePath()
getTimelineByInterval()
checkExtraction()
restart()
stop()
log()
isDataAvailable()
getJobFiles()
deleteJob()
deleteAndStopAllJobs()
extractionJobsInfo()
getExtractionJobs()
stopJob()
scheduleExtraction()
- recording_utils API
- RESTful API
Other Products