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

Endpoint Hierarchy NetBox's entire REST API is housed under the API root at https://<hostname>/api/. The URL structure is divided at the root level by application: circuits, DCIM, extras, IPAM, plugins, …

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.

Introduction to NetBox Origin Story NetBox was originally developed by its lead maintainer, Jeremy Stretch, while he was working as a network engineer at DigitalOcean in 2015 as part of an effort to …

NetBox Installation This section of the documentation discusses installing and configuring the NetBox application itself. Install System Packages Begin by installing all system packages required by …

systemctl restart netbox restarts the NetBox service, and initiates any changes made to ldap_config.py. If there are syntax errors present, the NetBox process will not spawn an instance, and errors should …

Required Configuration Settings ALLOWED_HOSTS This is a list of valid fully-qualified domain names (FQDNs) and/or IP addresses that can be used to reach the NetBox service. Usually this is the same …

While NetBox has very powerful data validation tools (including support for custom validation rules), ultimately the onus falls to a human operator to assert what is correct and what is not. For example, …

NetBox models network applications as discrete service objects associated with devices and/or virtual machines, and optionally with specific IP addresses attached to those parent objects.

Devices & Cabling At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of physical hardware installed within your …