ntopng Logo

User's Guide

  • What is ntopng
  • Use Cases
  • Basic Concepts
  • How to Start ntopng
  • Adding a License
  • Command Line Options
  • The ntopng Web GUI
  • Interfaces
  • Alerts
  • Developing Alerts
  • Active Monitoring
  • Self Monitoring
  • Using ntopng with ntop Tools
  • Historical Flow Report
  • ClickHouse
  • Advanced Features
  • Operating ntopng on large networks
  • Third-Party Integrations
  • FAQ
  • Performances

Developer's Guide

  • Developing Plugins
  • API Documentation
    • RESTful API
      • 1. RESTful API v2 Specification
      • 2. Examples v2
      • 3. RESTful API v1 Specification
      • 4. Examples v1
      • 5. RESTful API v0 Specification
      • 6. Examples v0
    • Lua C API
    • Timeseries API
    • Alerts API
    • Recording API

Other Products

  • nProbe
  • nProbe Cento
  • n2disk
  • nDPI
  • PF_RING
  • nEdge
  • nScrub
  • nBox
ntopng
  • API Documentation
  • RESTful API
  • View page source

RESTful API

ntopng provides a RESTful API for exporting data through HTTP including Interfaces/Hosts/Flows information and raw PCAP data.

  • 1. RESTful API v2 Specification
    • 1.1. Authentication
    • 1.2. Request Format
    • 1.3. Response Format
    • 1.4. API
  • 2. Examples v2
    • 2.1. Interfaces
    • 2.2. Hosts
    • 2.3. Flows
    • 2.4. Alerts
    • 2.5. L7 Application Protocols
    • 2.6. L7 Application Categories
    • 2.7. L4 Protocols
    • 2.8. Pools
    • 2.9. SNMP
    • 2.10. Misc
  • 3. RESTful API v1 Specification
    • 3.1. Authentication
    • 3.2. Request Format
    • 3.3. Response Format
    • 3.4. API
  • 4. Examples v1
    • 4.1. Interfaces
    • 4.2. Hosts
    • 4.3. Flows
    • 4.4. Alerts
    • 4.5. L7 Application Protocols
    • 4.6. L7 Application Categories
    • 4.7. L4 Protocols
    • 4.8. Pools
    • 4.9. SNMP
    • 4.10. Misc
  • 5. RESTful API v0 Specification
    • 5.1. Authentication
    • 5.2. API
  • 6. Examples v0
    • 6.1. Get Interface Data
    • 6.2. Get Host Data
    • 6.3. Get Flows Data
    • 6.4. Get Past Alerts Data
    • 6.5. Get Interface Timeseries
Previous Next

© Copyright 2024, ntop.

Built with Sphinx using a theme provided by Read the Docs.