Skip to content

Plugins

Jeff Gehlbach edited this page Jun 5, 2024 · 20 revisions

About Plugins

Plugins are packaged Django apps that can be installed alongside NetBox to provide custom functionality not present in the core application. Plugins can introduce their own models, views, and other resources, but cannot interfere with core components. A NetBox user may opt to install plugins provided by the community or build their own.

Plugins are supported on NetBox v2.8 and later.

Developing Plugins

Anyone is free and welcome to develop a plugin for NetBox. This can be a project that you use internally within your organization, an open source project, or even a proprietary product. To get started with a plugin, we suggest first completing the official development tutorial, which will walk you through the process of creating a plugin from scratch. From there, the plugins framework documentation should have everything you need.

Plugin Support

Please note that each plugin is its own project and maintained by its respective owner(s). The NetBox core team cannot provide assistance with plugin-specific issues. If you run into a problem installing or using a plugin, please consult the plugin's documentation to determine where to ask for help. (Generally, users will be advised to submit an issue to the plugin's repository on GitHub or elsewhere.)

NetBox Labs Plugin Certification Program

Plugin maintainers may apply to have their plugins certified by NetBox Labs through the Plugin Certification Program.

Plugins Catalog

Some of the more popular plugins that have been created for NetBox are collected in the NetBox Plugins Catalog. This list of course is always growing, so feel free to suggest additions. You can contact the plugin catalog team via email.

Plugin Ideas Board and Bounty Program

Got an idea for an amazing NetBox plugin, but aren't currently in a position to develop it yourself? Register it on the Plugin Ideas Board and another developer might run with it. If the idea really catches fire, the developer who builds it could even get paid a bounty!