This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installation, the general approach outlined …

Below is a simplified overview of the NetBox application stack for reference: Upgrading. If you are upgrading from an existing installation, please consult the upgrading guide.

NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure …

NetBox models cables as connections among certain types of device components and other objects. Each cable can be assigned a type, color, length, and label. NetBox will enforce basic …

NetBox's REST API, powered by the Django REST Framework, provides a robust yet accessible interface for creating, modifying, and deleting objects. Employing HTTP for transfer and JSON …

Every piece of hardware which is installed within a site or rack exists in NetBox as a device. Devices are measured in rack units (U) and can be half depth or full depth. A device may have …

Comprehensive, interactive documentation of all REST API endpoints is available on a running NetBox instance at /api/schema/swagger-ui/. This interface provides a convenient sandbox for …

NetBox will prefer IPv6 addresses over IPv4 addresses by default. This can be changed by setting the PREFER_IPV4 configuration parameter.

Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just like physical objects, …

May 1, 2025 · NetBox v4.3 requires PostgreSQL 14.0 or later. The ALLOW_TOKEN_RETRIEVAL configuration parameter now defaults to False. The device and virtual_machine foreign keys …