NetBox Data Flows Plugin

NetBox plugin to document Data Flows between devices and applications.

Features

Document data flows between IP addresses, IP ranges and Prefixes documented in NetBox.
Regroup the data flows into applications and hierarchical groups.

Documenting your data flows can help you design the network architecture, automate your firewall rule definition or reviews, implement security contracts in a software-defined network, or respond to compliance requirements.

Screenshots

Data Flow

Representation of a data flow A data flow for an application, here representing the user access to frontend servers and backend servers over TCP/443.

Targets of a data flow Details of the data flow specifications, displaying all the IP addresses, IP ranges and Prefixes that are involved in that data flow.

Application

All the data flows mapped to one application The application allows you to group all the related data flows. Optionally, you can assign devices or other NetBox objects to an application, using a custom field.

Device tab views

List of data flows involving a VM The plugin adds Tab views to Devices, Virtual Machines, IP addresses, IP ranges and Prefixes to list all the data flows that involve them as a source or destination.

Getting started

Read the Quick Start tutorial to discover how to use the plugin.

Data model

The data model and design's decisions can be found in the documentation.

Installation and configuration

Instructions to install, configure, update or uninstall the plugin can be found in the plugin's documentation.

Supported Versions

netbox version	netbox-data-flows version
>= 4.7.0	>= v1.5.4
>= 4.6.0	>= v1.5.2, < v1.6.0
>= 4.5.0	>= v1.4.1, < v1.5.3
>= 4.4.0	>= v1.2.1, < v1.5.0
>= 4.3.0	>= v1.1.1, < v1.5.0

Older versions

Only the latest version of the plugin is officially supported. The test suite is run on the latest patch version of the current version of NetBox, and the previous one (if no breaking compatibility change).

Dependencies

NetBox
Python 3.12 or higher

Contributions

Contributions are welcomed. This plugin is developped on the free time of its author, so do not expect regular releases.

Please report security vulnerabilities via GitHub security advisory. Do not create a public issue. See also the Security Policy.

Please report bugs and feature requests in GitHub.

GitHub Discussions are opened for general help requests and any other topics you may want to discuss.

Known bugs and limitations

GraphQL API is not implemented

Metadata

Release files for netbox-data-flows 1.5.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for netbox-data-flows 1.5.4
File	Size	Uploaded
netbox_data_flows-1.5.4.tar.gz	3.4 MB	Aug 22, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for netbox-data-flows 1.5.4
File	Interpreter	ABI	Platform	Reset
netbox_data_flows-1.5.4-py3-none-any.whl 82.1 kB Aug 22, 2026	Python 3	none	any	Details

Total release size: 3.5 MB

Release files / netbox_data_flows-1.5.4.tar.gz

Download URL	netbox_data_flows-1.5.4.tar.gz
Size	3.4 MB
Tags	Source
SHA-256 checksum How to use checksums	`5a69170b0fcf4a8e04a3efae1ce639144b021609b3ccbb67cbdeae80c38ebaa6`
BLAKE2b-256 checksum How to use checksums	`60a2f714649ad75d0543ce1e2166383f2cc65e65c85f11b3bdd8269e45b900ba`
Upload date	Aug 22, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Alef-Burzmali/netbox-data-flows
Publishing commit: github.com/Alef-Burzmali/netbox-data-flows/tree/4f3c4a5eb5af88abffc95d049d3acb7869281637

Workflow

Publishing configuration: github.com/Alef-Burzmali/netbox-data-flows/blob/4f3c4a5eb5af88abffc95d049d3acb7869281637/.github/workflows/publish-pypi.yml
Publishing logs: github.com/Alef-Burzmali/netbox-data-flows/actions/runs/32591236994/attempts/1

Artifact

Subject: netbox_data_flows-1.5.4.tar.gz
SHA-256 checksum: 5a69170b0fcf4a8e04a3efae1ce639144b021609b3ccbb67cbdeae80c38ebaa6 Verifying attestations

Release files / netbox_data_flows-1.5.4-py3-none-any.whl

Download URL	netbox_data_flows-1.5.4-py3-none-any.whl
Size	82.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`40781081e39388217c43d0c98cd45b5eaccfde81bed93fcb2e83e118c34d7ae6`
BLAKE2b-256 checksum How to use checksums	`690eedd649571837cdf85ed7fbee23ea5ae750e95aa49038aafd3bb1a7c5f624`
Upload date	Aug 22, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/Alef-Burzmali/netbox-data-flows
Publishing commit: github.com/Alef-Burzmali/netbox-data-flows/tree/4f3c4a5eb5af88abffc95d049d3acb7869281637

Workflow

Publishing configuration: github.com/Alef-Burzmali/netbox-data-flows/blob/4f3c4a5eb5af88abffc95d049d3acb7869281637/.github/workflows/publish-pypi.yml
Publishing logs: github.com/Alef-Burzmali/netbox-data-flows/actions/runs/32591236994/attempts/1

Artifact

Subject: netbox_data_flows-1.5.4-py3-none-any.whl
SHA-256 checksum: 40781081e39388217c43d0c98cd45b5eaccfde81bed93fcb2e83e118c34d7ae6 Verifying attestations