vrr/ntopng
2
0
Fork 0
mirror of https://github.com/ntop/ntopng.git synced 2026-05-06 03:45:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
ntopng/python
History
Luca Deri 6b1bcc490c Added token-based authentication 
https://www.ntop.org/guides/ntopng/advanced_features/authentication.html?highlight=token#token-based-authentication
2022-12-05 20:54:08 +01:00
..
ntopng Added token-based authentication 2022-12-05 20:54:08 +01:00
__init__.py.in Added pip packaging 2022-12-04 12:41:22 +01:00
Makefile Added make targets for pip package 2022-12-05 12:15:39 +01:00
README.md Added install information 2022-12-05 11:23:30 +00:00
setup.py.in Added pip packaging 2022-12-04 12:41:22 +01:00
test.py Added token-based authentication 2022-12-05 20:54:08 +01:00

README.md

Python API

This directory contains the Python 3.x API for querying ntopng using the Python language.

This API is based on ntopng's REST API and it allows users to perform operations such as:

  • Read host statistics
  • Get the active flows list
  • Query network interface stats
  • Search historical flows

API Information

For each ntopng REST API call there is a corresponding Python method for the defined Python classes:

The ntopng class is used to store information such as ntopng IP address and credentials used to connect it.

The test application can be used as example of the Python API

Installation

For you convenience, ntop periodically builds pip packages. You can install the latest available package as:

  • pip3 install ntopng

Developing the Python API

We encourage our users to extend this API. For your convenience we are sharing a Makefile that you can use as skeleton for installing the package locally or creating test packages.

Documentation

ntopng REST API v2