Configuration

netbox-pbs discovers its proxbox-api backend in this order:

1. If netbox-proxbox is installed, the singleton FastAPIEndpoint row is reused as the backend (host, port, API key, and verify_ssl are taken from netbox_proxbox.services.backend_context.get_fastapi_request_context()).
2. Otherwise the plugin's own proxbox_api_url / proxbox_api_key settings stored in PBSPluginSettings are used.

PLUGINS_CONFIG (fallback only)

Set these in configuration.py only when netbox-proxbox is not installed:

PLUGINS_CONFIG = {
    "netbox_pbs": {
        # Fallback used only if netbox-proxbox is not installed.
        "proxbox_api_url": "http://proxbox-api.internal:8000",
        "proxbox_api_key": "<api-key>",
    },
}

When netbox-proxbox is present, these values are ignored.

PBSPluginSettings (NetBox UI tunables)

After installation, open Plugins → PBS → Plugin Settings (or GET /api/plugins/pbs/settings/) to configure the singleton PBSPluginSettings object:

Setting	Default	Description
proxbox_api_url	—	proxbox-api base URL (fallback only)
proxbox_api_key	—	Bearer / API key (fallback only)
branching_enabled	False	Wrap each sync run in a NetBox branch (requires netbox-branching)
branch_name_prefix	"pbs-sync"	Prefix for auto-created branch names
branch_on_conflict	"fail"	What to do when a branch merge hits conflicts: fail (job fails) or acknowledge (merge anyway)