Skip to main content

NetBox Copilot Quickstart Guide

Get NetBox Copilot up and running in your NetBox instance in just a few minutes.

Prerequisites​

Before you begin, make sure you have:

  • NetBox 4.4.5 or higher (recommended for native preference enablement)
  • A modern web browser: Chrome/Edge 90+, Firefox 88+, or Safari 14+

Installation Options​

For NetBox 4.4.5 and later, enable Copilot directly in your user settings:

  1. Log in to your NetBox instance
  2. Navigate to your User Preferences (click your username in the top-right, then "Preferences")
  3. Find the Copilot section
  4. Toggle Enable Copilot to on
  5. Save your preferences

Copilot will appear in the bottom-right corner of your NetBox interface.

NetBox Copilot preference in User Preferences

Option 2: Console Injection (Older NetBox Versions)​

For NetBox versions prior to 4.4.5, inject Copilot via the browser console. We recommend upgrading to 4.4.5+ for the best experience.

  1. Open your NetBox instance in your browser
  2. Open the developer console (F12 on Windows/Linux, Cmd+Option+I on Mac)
  3. Paste this code and press Enter:
const script = document.createElement('script');
script.src = 'https://static.copilot.netboxlabs.ai/load.js';
document.head.appendChild(script);

Copilot should appear in the bottom-right corner within a few seconds. You'll need to re-run the script after refreshing or closing your browser.

Verify Installation​

After enabling Copilot, look for the Copilot icon in the bottom-right corner of your NetBox page.

Copilot icon in the bottom-right corner of NetBox

If Copilot doesn't appear, see Troubleshooting in the Usage Guide.

Create Your Account​

The first time you open Copilot:

  1. Click the Copilot interface in the bottom-right corner
  2. You'll see a sign-up or login screen for NetBox Cloud
  3. New users: Choose an authentication method (SSO or email) and sign up for a NetBox Cloud account
  4. Existing users: Log in with your existing credentials

The free tier includes AI credits to get started. Visit netboxlabs.com/pricing for details on plans and credit allocations.

NetBox Copilot account creation/login window will pop up

Your First Conversation​

Once logged in, you're ready to start using Copilot!

Try these example queries:

  1. Find devices: "Show me all devices in [your site name]"
  2. Check IPs: "What IP addresses are available in 10.0.1.0/24?"
  3. Inspect interfaces: "Which interfaces on [device name] are not connected?"
  4. Review changes: "What changes were made to this device?" (when viewing a device page)
  5. Get help: "How do VRFs work in NetBox?"

Ask NetBox Copilot a question about NetBox or your data and it will hunt down the answer

Understanding Responses:

Copilot will:

  • Answer in natural language
  • Show you how it gathered the information (thinking and tool usage traces)
  • Maintain context across your conversation

Tips:

  • Copilot knows what page you're on—you can say "this device" or "this site"
  • Follow up with additional questions to drill deeper
  • Ask Copilot to explain if something isn't clear

What's Next?​

Now that you have Copilot running, explore what it can do:

  • Usage Guide - Learn about all of Copilot's capabilities and best practices
  • Privacy & Security - Understand how your data is handled
  • FAQ - Get answers to common questions

Getting Help​

Need assistance?

  • Use the feedback button within Copilot (preferred—includes context automatically)
  • Contact NetBox Labs support
Last updated on