NetBox

The NetBox connector allows you to synchronize your network infrastructure management data directly from your NetBox instance.

Overview

The NetBox connector enables you to collect the following information:

• IP addressing plan (IPAM)
• Network equipment inventory
• Cabling and topology

Prerequisites

• Accessible NetBox instance (version 3.0+)
• NetBox API token generated
• Read permissions on IPAM and inventory data

Information to provide in OverSOC

Configuration

Generate a NetBox API token

1. Log in to your NetBox instance.
2. Click your user profile icon in the top-right corner.
3. Select API Tokens from the menu.
4. Click Add a token.
5. Fill in the token details:
   • Description: OverSOC Connector
   • Write enabled: Leave unchecked (read-only recommended)
6. Click Create.
7. Immediately copy the token value (it will only be displayed once). The token will have the format nbt_... when using v2 API.

Configure the connector in OverSOC

1. In OverSOC, go to Data Sources Settings > Sources.
2. Select NetBox and click Configure.
3. Fill in the required fields:
   • Server URL: Your NetBox instance URL (e.g., https://netbox.example.com)
   • API Token: Your generated token
4. Click Save Configuration.

Reference: NetBox REST API - Authentication

Required Permissions

The API token must have the following minimum permissions:

• Read access to IPAM objects (IP Addresses, Prefixes, VLANs, etc.)
• Read access to inventory (Devices, Device types, Interfaces, etc.)
• Read access to cabling (Cables, Power connections, etc.)