NetBox
Synchronize your IPAM, network inventory and cable topology
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 OverView
| Field | Description |
|---|---|
| API Token | NetBox API authentication token |
| Server URL | URL of your NetBox instance (e.g., https://netbox.example.com) |
Parameters
These parameters are optional. Leave them at their default value unless you have a specific reason to change them.
| Parameter | Description | Default |
|---|---|---|
| Verify SSL | Verify SSL certificate when connecting to the API | Disabled |
| Statuses to import | NetBox statuses of the devices and virtual machines to import. Default values: active, offline, planned, staged, failed, decommissioning, inventory (devices only), paused (virtual machines only). Custom statuses defined in NetBox are also accepted. Devices and virtual machines with another status are not retrieved. Leave empty to import all statuses | Empty (all statuses) |
Configuration
Generate a NetBox API token
- Log in to your NetBox instance.
- Click your user profile icon in the top-right corner.
- Select API Tokens from the menu.
- Click Add a token.
- Fill in the token details:
- Description: OverView Connector
- Write enabled: Leave unchecked (read-only recommended)
- Click Create.
- 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 OverView
- In OverView, go to Data Sources Settings > Sources.
- Select NetBox and click Configure.
- Fill in the required fields:
- Server URL: Your NetBox instance URL (e.g., https://netbox.example.com)
- API Token: Your generated token
- 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.)
Alternative: file import through DropPoint
The API access described above is the recommended method for this connector. Where it is not available (a segregated network, a version or licence without API, an export you already produce), OverView accepts file exports, to be uploaded to the bucket dedicated to NetBox.
Bucket : s3://netbox/
Example : s3://netbox/export.csv
The procedure is described in the OverView DropPoint guide: generating credentials, configuring the client, then sending files from the OverView web interface, the AWS CLI or an SDK. Its examples come pre-filled with this bucket when you follow this link.