netbox-sqids 0.1.2

NetBox plugin that adds short, URL-safe, globally unique SQID identifiers to every model

NetBox SQIDs

Alpha -- this plugin is functional but under active development. The API and SQID encoding may change before 1.0.

Short, URL-safe, globally unique identifiers for every NetBox object.

NetBox SQIDs adds a computed sqid property to every model in your NetBox instance. SQIDs encode the content type and primary key into a compact string that can be shared, bookmarked, and resolved back to the original object — no database changes required.

Quick Example

>>> device = Device.objects.first()
>>> device.sqid
'WK1J'

>>> from netbox_sqids.sqids import resolve_sqid
>>> resolve_sqid('WK1J')
<Device: my-switch>

Visit /s/WK1J/ in your browser to be redirected to the device's detail page.

Features

• Zero-config — install and every model gets a .sqid property
• No migrations — pure computed properties, no database changes
• Globally unique — SQIDs are unique across all models
• URL-safe — curated 33-character alphabet, no ambiguous characters
• Redirect views — resolve any SQID via browser or API
• Short URLs — optional root-level routes like /s/WK1J/

Requirements

Dependency	Version
NetBox	>= 4.5.0
Python	>= 3.12

Installation

pip install netbox-sqids

Add to your NetBox configuration.py:

PLUGINS = ["netbox_sqids"]

Restart NetBox. That's it.

Configuration

All settings are optional:

PLUGINS_CONFIG = {
    "netbox_sqids": {
        "min_length": 4,                      # Minimum SQID length (default: 4)
        "blocklist": None,                    # Word blocklist (None = extended default)
        "monkeypatched_url_prefix": "s",      # Short URL prefix (None to disable)
    },
}

URL Routes

Route	Description
/plugins/sqids/<sqid>/	Browser redirect to object
/api/plugins/sqids/<sqid>/	API redirect to object
/s/<sqid>/	Short browser redirect (configurable)
/api/s/<sqid>/	Short API redirect (configurable)

Documentation

Full documentation: jsenecal.github.io/netbox-sqids

License

MIT