Proxbox¶

Proxbox is a NetBox plugin that integrates Proxmox with NetBox through a separate FastAPI backend.

Compatibility¶

The current repository code declares support for:

NetBox 4.5.x
Plugin version 0.0.7 in source

That support comes directly from the plugin config in this repository:

min_version = "4.5.0"
max_version = "4.5.99"

The latest upstream NetBox release verified during this docs update was v4.5.5, published on 2026-03-17.

Important Packaging Note¶

The repository is ahead of the latest published PyPI release of netbox-proxbox.

Use the Git/source installation path if you want the code documented here.
Do not assume older 0.0.6 prerelease installation instructions apply to the current branch.

What The Plugin Contains¶

The current codebase includes NetBox models for:

Proxmox endpoints
NetBox endpoints
FastAPI endpoints
sync processes
VM backups

The plugin UI exposes sync actions for:

devices
virtual machines
full update
VM backups

Architecture¶

Proxbox is split into two services:

The NetBox plugin from this repository.
A separate FastAPI backend service, proxbox-api.

The NetBox plugin stores endpoint configuration and triggers sync requests. The backend talks to Proxmox and NetBox over HTTP and streams real-time progress updates via SSE (Server-Sent Events). Legacy WebSocket streaming is also supported.

Recommended Install Path¶

For the current repository state, the recommended path is:

Install the plugin from Git/source into the NetBox virtual environment.
Run migrations and collect static assets.
Install and run proxbox-api.
Configure Proxmox API, NetBox API, and ProxBox API (FastAPI) objects in the NetBox UI.
Run Full Update from Plugins > Proxbox.

See:

Read-Only Proxmox Behavior¶

Proxbox currently focuses on synchronization and discovery. The plugin does not directly manage Proxmox resources from NetBox.