NetBox API
Community OpenAPI document · agent-readyCloud InfrastructureNetworkingapikey844 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Read and manage NetBox infrastructure records across DCIM, IPAM, tenancy, circuits, virtualization, and wireless, with list, create, update, and delete operations against your NetBox instance.
Use for: List all devices in my data center, Find the IP addresses in a prefix, Create a new rack in NetBox, Show which VLANs are defined
Not supported: Does not handle device configuration push, live monitoring, or alerting. Use for reading and managing NetBox infrastructure records only.
The NetBox API reads and manages the infrastructure records that NetBox holds as a network source of truth. It covers DCIM data such as devices, racks, and cables, IPAM data such as IP addresses, prefixes, and VLANs, and further apps for tenancy, circuits, virtualization, and wireless, with most record types supporting list, create, update, and delete operations against your own NetBox instance.
Install Jentic One Beta
Connect the NetBox API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the NetBox API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnetbox.dev%2Fnetbox" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fnetbox.dev%2Fnetbox" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with NetBox API.
Manage DCIM records such as devices, racks, and cables
Manage IPAM records such as IP addresses, prefixes, and VLANs
Manage tenancy, circuits, and virtualization records
Manage wireless links and extras such as tags and custom fields
Check the NetBox instance status
Use Cases
Patterns agents use NetBox API for, with concrete tasks.
★ Infrastructure Inventory Queries
An AI agent answers questions about physical infrastructure by reading NetBox DCIM records. The devices and racks operations return the equipment and layout for a site, so an operations assistant can report what is installed where without a human opening the NetBox interface.
Call the DCIM devices operation, filter by site or rack, and summarize the equipment for the user.
IP Address Management
A workflow finds and records IP addresses using NetBox IPAM. The prefixes and IP addresses operations let an agent see what is allocated in a subnet and create a new address, so provisioning can reserve space in the source of truth automatically.
Read a prefix, identify free space, and create an IP address record in NetBox.
Virtualization and Tenancy Records
An agent keeps virtual machine and tenant records aligned with reality. The virtualization operations list and update virtual machines, and the tenancy operations track which tenant owns each resource, giving an agent a way to reconcile ownership and inventory.
List virtual machines, compare them against the live environment, and update the records that have drifted.
Key Endpoints
844 endpoints — the netbox api reads and manages the infrastructure records that netbox holds as a network source of truth.
METHOD
PATH
DESCRIPTION
GET
/dcim/devices/
List DCIM devices
GET
/ipam/ip-addresses/
List IP addresses
GET
/ipam/prefixes/
List IP prefixes
GET
/dcim/racks/
List racks
GET
/status/
Check NetBox instance status
GET
/dcim/devices/
List DCIM devices
GET
/ipam/ip-addresses/
List IP addresses
GET
/ipam/prefixes/
List IP prefixes
GET
/dcim/racks/
List racks
GET
/status/
Check NetBox instance status
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the NetBox API by hand means holding an API token in the Authorization header and navigating its 844 operations across DCIM, IPAM, tenancy, and virtualization yourself. Through Jentic you install once, import it from the API Directory, store the token once, and your agent calls it.
Permission scoping
Because operations are addressed by record IDs across DCIM, IPAM, and other apps, a rule can pin your agent to reading devices without letting it delete IP addresses. You choose the operations and records it may reach, so the rest stay out of scope unless you add them.
Credential isolation
Your NetBox API token is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'list NetBox devices' or 'find an IP address', and Jentic returns the matching NetBox operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using NetBox API through Jentic.
What authentication does the NetBox API use?
Every request requires an API token in the Authorization header, per its OpenAPI spec. You generate the token in your own NetBox instance. Through Jentic the token is stored encrypted in your own Jentic One instance and injected at call time.
What can the NetBox API manage?
It covers NetBox's apps, including DCIM for devices, racks, and cables, IPAM for IP addresses, prefixes, and VLANs, plus tenancy, circuits, virtualization, and wireless. Most record types support list, create, update, and delete operations, so an agent can both read and change your source of truth.
What are the rate limits for the NetBox API?
The OpenAPI spec does not specify rate limits, since NetBox runs on your own instance. Check your NetBox configuration for any pagination or throttling settings before running large queries across its many records.
How do I list devices with the NetBox API through Jentic?
Search Jentic for 'list NetBox devices', add the NetBox API from the directory, and your agent calls the DCIM devices operation against your instance using your stored API token. To run it on your own infrastructure, install Jentic One from its GitHub repo.
Is there a NetBox API MCP server?
You don't need an MCP server to give your agent the NetBox API. Jentic connects it directly from the API Directory: import it, store your API token once, and your agent calls the DCIM and IPAM operations. Nothing extra loads into the agent's context until a call is made.
Can I limit what my agent is allowed to do with the NetBox API?
Yes. Write a rule that allows just the operations you want, such as reading devices and IP addresses without deleting anything, so the agent cannot call anything else, and every call is logged. Because operations are scoped by record ID across NetBox's apps, rules can bound the exact records your agent reaches.
GET STARTED