Skip to main content

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).

Abbreviated changelog

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

See also the list of issues.

Metadata

Release files for netbox-data-flows 1.6.0

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.6.0
File Size Uploaded Provenance Actions
netbox_data_flows-1.6.0.tar.gz 3.4 MB With provenance Details for netbox_data_flows-1.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for netbox-data-flows 1.6.0
File Interpreter ABI Platform Actions
netbox_data_flows-1.6.0-py3-none-any.whl Python 3 none any Details for netbox_data_flows-1.6.0-py3-none-any.whl

Total release size: 3.5 MB

Release files / netbox_data_flows-1.6.0.tar.gz

Download URL netbox_data_flows-1.6.0.tar.gz
Size 3.4 MB
Tags Source
SHA-256 checksum
How to use checksums
c0d84a0142e13f09748b029b21cfa54b1941b362e02d5f60599917352aa88f96
BLAKE2b-256 checksum
How to use checksums
762f129c3fc91e3ed8dccb90f02a95a3a28550de83b8e54495beafefa0e74cc4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.

Transparency log

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

Download URL netbox_data_flows-1.6.0-py3-none-any.whl
Size 89.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4778eaf9c81d1c476a78344aa13ef5788edfa71e92bb6644c36f5451fbcbee0c
BLAKE2b-256 checksum
How to use checksums
ebdb6291156ef9e3c530d8453d9084faa216cd805a9cdde868a5c809c5cd2b7c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.

Transparency log

Security for netbox-data-flows 1.6.0

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for netbox_data_flows-1.6.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 25, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.6.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page