Skip to main content

NetBox Scripts

Manage, validate and run Python scripts in NetBox.

Upload scripts or connect a Project to a directory in a NetBox Data Source. The plugin keeps source in immutable revisions, validates changes before activation and lets each Project serve one active revision at a time.

What you can do

  • Run scripts where you need them. Use the NetBox interface, REST API, Event Rules or command line, with support for dry runs, scheduled runs and recurring execution.
  • Set defaults for each script. Configure its timeout, notification policy and commit behavior.
  • Use familiar NetBox interfaces. Browse Projects, Script Files and Scripts through the UI, REST API, GraphQL and global search, with read-only views of revision details.
  • Bring your existing scripts. Keep using extras.scripts imports or adopt the plugin's authoring API. A migration workflow helps you move from NetBox's built-in Custom Scripts. The extras.scripts compatibility layer is transitional and stops working at NetBox v5.0. Legacy Reports are not supported.

See the Features guide for supported functionality and current limitations.

Compatibility

Plugin version Minimum NetBox Maximum NetBox Minimum Python
0.1.0 4.7.5 4.7.99 3.12

See COMPATIBILITY.md for the per-release compatibility matrix.

Getting started

Once the release is published on PyPI, install it in your NetBox virtual environment:

pip install netbox-scripts

For local development, run pip install -e . from the repository root instead.

Add netbox_scripts to PLUGINS in NetBox's configuration.py, keeping any existing plugins:

PLUGINS = [
    # Keep your existing plugins here.
    'netbox_scripts',
]

Configure source storage in the same file. This is required even when you use the default plugin settings. For a single-node installation:

STORAGES = {
    'netbox_scripts': {
        'BACKEND': 'django.core.files.storage.FileSystemStorage',
        'OPTIONS': {
            'location': '/var/lib/netbox-scripts',
        },
    },
}

Keep any existing custom storage entries when adding this configuration. NetBox merges it with its built-in storage entries. The plugin requires its own storage entry and does not fall back to default.

Create the directory and allow the NetBox web and worker processes to read and write it. Only trusted service or deployment accounts should have write access. The installation guide covers directory setup, static files and restarting the services.

Apply database migrations from the NetBox directory containing manage.py:

python manage.py migrate

All PLUGINS_CONFIG settings are optional. See the configuration guide for available settings and object storage options, and the documentation for the complete setup and usage guides.

Feedback and support

Found a bug or something that is hard to use? Please open an issue. Include your NetBox and plugin versions, what you expected and what happened. Feedback on installation, migration and documentation is especially helpful during the beta. Remove credentials and private data from reports and logs.

Report suspected vulnerabilities privately. Follow SECURITY.md rather than opening a public issue.

Contributing

Code, documentation, bug reports and feature proposals are welcome. Read CONTRIBUTING.md for the issue and assignment process, development setup and checks.

License

Licensed under the Apache License 2.0.

Copyright (c) 2026 NetBox Labs.

Metadata

Release files for netbox-scripts 0.1.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-scripts 0.1.0
File Size Uploaded Provenance Actions
netbox_scripts-0.1.0.tar.gz 510.9 kB With provenance Details for netbox_scripts-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for netbox-scripts 0.1.0
File Interpreter ABI Platform Actions
netbox_scripts-0.1.0-py3-none-any.whl Python 3 none any Details for netbox_scripts-0.1.0-py3-none-any.whl

Total release size: 1.1 MB

Release files / netbox_scripts-0.1.0.tar.gz

Download URL netbox_scripts-0.1.0.tar.gz
Size 510.9 kB
Tags Source
SHA-256 checksum
How to use checksums
ad732bd76641086bc67c413379acef2a7a67ff01ca11c05ca2af55b0ec49f022
BLAKE2b-256 checksum
How to use checksums
119cbbd8d6c393ca1b907ac4f92efeb6e7e72f243749adfee87115af52b53184
Upload date
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.

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 Nov 12, 2026.

Transparency log

Release files / netbox_scripts-0.1.0-py3-none-any.whl

Download URL netbox_scripts-0.1.0-py3-none-any.whl
Size 618.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f2b8c594acb7d7996f08e940b3b1becc44cb0935db708b8f51f71be8b1f9a291
BLAKE2b-256 checksum
How to use checksums
eaedac69b34230e10887a54461fd3c86a89e74149b09c7edae85c672cf07c851
Upload date
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.

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 Nov 12, 2026.

Transparency log

Security for netbox-scripts 0.1.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_scripts-0.1.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 Nov 12, 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

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