NetBox Attachments Plugin

NetBox plugin for attaching files to NetBox objects.

Overview

netbox-attachments adds an attachment model and UI/API workflows to upload, link, and manage files against NetBox models.

Compatibility

Supported now:

  • NetBox: 4.7.x
  • Plugin: 12.x (use 11.x for NetBox 4.5–4.6)
  • Python: 3.12, 3.13, 3.14

Compatibility details and legacy version notes are documented in docs/compatibility.md.

Upgrading to NetBox 4.6 with existing attachments? A foreign-key error in migration 0007 can occur because NetBox 4.6 populates core_objecttype via a post-migrate signal. See the NetBox 4.6 upgrade notes and the fix_attachment_object_types management command (issue #107).

Installation

Install from PyPI:

pip install netbox-attachments

Enable the plugin in configuration.py:

PLUGINS = ["netbox_attachments"]

Create storage directory and set permissions:

mkdir -p /opt/netbox/netbox/media/netbox-attachments
chown netbox /opt/netbox/netbox/media/netbox-attachments

Run migrations:

python3 manage.py migrate netbox_attachments

Full installation details: docs/installation.md.

Configuration

Plugin settings are configured via PLUGINS_CONFIG["netbox_attachments"].

PLUGINS_CONFIG = {
    "netbox_attachments": {
        "applied_scope": "model",
        "scope_filter": ["dcim.device", "ipam.prefix", "tenancy"],
        "display_default": "right_page",
        "create_add_button": True,  # show top "Attachments" dropdown in additional_tab mode
        "display_setting": {"ipam.vlan": "left_page"},
    }
}

Complete settings reference: docs/configuration.md.

API

Attachment APIs are exposed under:

  • /api/plugins/netbox-attachments/netbox-attachments/
  • /api/plugins/netbox-attachments/netbox-attachment-assignments/

Workflow:

  1. Upload/create attachment via netbox-attachments.
  2. Link it to an object via netbox-attachment-assignments.

Additional usage details: docs/usage.md.

Testing

Primary local command:

make test

Packaging check:

python -m build

Support

Contributing

Contribution workflow and expectations are documented in CONTRIBUTING.md.

Release Notes

Project release history follows Keep a Changelog:

Screenshots

  • Attachment List Attachment list view
  • Attachment Detail Attachment detail view
  • Object Attachments Tab Object attachments tab
  • Create Assignment Create assignment form

License

Licensed under Apache 2.0. See LICENSE.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for jankrupa from gravatar.com jankrupa Avatar for jiri.vrany from gravatar.com jiri.vrany

Credits

Author: Jan Krupa

License expression

Apache-2.0
View SPDX License List

Requires

Python <3.15, >=3.12

Provides Extra

test

Tags

netbox netbox-plugin

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

netbox_attachments-12.0.0.tar.gz (375.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_attachments-12.0.0-py3-none-any.whl (80.9 kB view details)

Uploaded Python 3

File details

Details for the file netbox_attachments-12.0.0.tar.gz.

File metadata

  • Download URL: netbox_attachments-12.0.0.tar.gz
  • Upload date:
  • Size: 375.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for netbox_attachments-12.0.0.tar.gz
Algorithm Hash digest
SHA256 d4c66e8eba4a78db612a5e88618b7b9327d1584883ed14e7c245fdb0f314b633
MD5 0bc3e0fb530d12d0b87fde884e8b11c9
BLAKE2b-256 e819ed6c55fa0038c3291e4af5b2951930654ec1fc43f9005a13a2529c2415a4

See more details on using hashes here.

File details

Details for the file netbox_attachments-12.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_attachments-12.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbf50d01a4579515b25fabd888f464258a136ddf92d9472c63802056710a9e29
MD5 733ad717c6b9a927d5e17699d57e3724
BLAKE2b-256 e6f9f60d4d58d0c6c136b66cb603da442acf82c1c4bb41303c3a2d66a4ec351d

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

12.0.0 This release

2 files

11.3.1

2 files

11.3.0

2 files

11.2.3

2 files

11.2.2

2 files

11.2.1

2 files

11.2.0

2 files

Pre-release

11.2.0b1

2 files

11.1.0

2 files

11.0.1

2 files

Pre-release

11.0.0b5

1 file

10.0.1

2 files

10.0.0

2 files

9.0.1

2 files

9.0.0

2 files

Pre-release

9.0.0b1

2 files

8.0.4

2 files

Yanked

8.0.3

2 files

Yanked reason: Bug: Unable to render panel

Yanked

8.0.2

2 files

Yanked reason: Bug: Multiple panels displayed

Yanked

8.0.0

2 files

Yanked reason: Bug causing multiple ‘Add Attachment’ buttons to be displayed.

7.2.0

2 files

7.1.0

2 files

7.0.1

2 files

7.0.0

2 files

6.0.0

2 files

Pre-release

6.0.0b1

2 files

Pre-release

5.1.4b1

2 files

5.1.3

2 files

Yanked

5.1.2

2 files

Yanked reason: Wrong version set

Pre-release

5.1.2b2

2 files

5.1.1

2 files

5.1.0

2 files

Yanked

5.0.1

2 files

Yanked reason: Contains bug with serializer

Yanked

5.0.0

2 files

Yanked reason: Contains bug with serializer

Pre-release

5.0.0b1

2 files

4.0.2

2 files

4.0.1

2 files

4.0.0

2 files

3.0.2

2 files

3.0.1

2 files

3.0.0

2 files

2.0.4

2 files

2.0.3

2 files

Yanked

2.0.2

2 files

Yanked reason: Breakes inserting new attachments

2.0.1

2 files

2.0.0

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

1 file

1.0.0

1 file

0.0.6

1 file

0.0.5

1 file

Yanked

0.0.4

1 file

Yanked reason: Missing Manifest file - Causes missing template error

Yanked

0.0.3

1 file

Yanked reason: Missing Manifest file - Causes missing template error

Yanked

0.0.2

1 file

Yanked reason: Missing Manifest file - Causes missing template error

Yanked

0.0.1

1 file

Yanked reason: Missing Manifest file - Causes missing template error

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