Skip to main content
Skip table of contents

NetBox

What is NetBox?

NetBox is an application that models and documents modern networks. The application includes IP address management (IPAM), datacenter infrastructure management (DCIM), and APIs and extensions.

Why Should You Use the NetBox Connector?

The NetBox connector provides visibility into the assets in your environment. You can use this visibility to:

  • ensure assets are managed per your security policies

  • derive relationships between assets, users, applications, and data

How Does This Connector Work?

Lucidum executes read-only requests to the NetBox REST API and ingests only meta-data about NetBox devices. Lucidum does not retrieve any data stored on your assets.

Configuring the Connector in Lucidum

Field

Description

Example

URL

The URL for the NetBox API.

http://ip_address:port_number/imcrs
https://ip_address:port_number/imcr.

API Token

API Token for a NetBox account with read access.

************

Proxy

If you are using a proxy server to allow this connector to communicate with on-premises devices, enter the IP address: port for the proxy server, usually 192.168.255.6:3128

192.168.255.6:3128

Source Documentation

Creating Credentials

To create a user account for the Lucidum connector with permissions to view devices, see:

  1. Log in to the web UI for NetBox as a user with “staff” permissions or greater.

  2. In the Admin menu, select Authentication.

  3. In the Django administration subsite, create a new user.

  4. Assign the user View permissions for Devices.

To generate an API Token for the account:

  1. Login to the web UI for netbox as the user with View permissions for Devices.

  2. Click on your user profile

  3. Navigate to the API tokens.

  4. Generate an API token for the account.

Required Permissions

View Devices (dcim.view_device)

API Documentation

https://netbox.grid.uchicago.edu/api/docs/

https://docs.netbox.dev/en/stable/integrations/rest-api/

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.