NetBox API

Name: NetBox API
Brand: NetBox API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureNetworkingbearer844 EndpointsREST

For Agents

Read and write infrastructure source-of-truth data in NetBox: devices, IPs, VLANs, circuits, racks, sites, and tenancy.

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.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic 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.

Allocate, reserve, and release IP addresses and prefixes through the IPAM endpoints

Inventory devices, racks, modules, and cables across one or many sites

Manage circuits and circuit terminations from upstream providers

GET STARTED

Start building with NetBox API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI specification for NetBox API, keeping it validated and agent-ready. NetBox is the open-source source-of-truth platform for network and data centre infrastructure: device inventory, IP address management, VLANs, circuits, racks, cables, and tenancy modelled in one queryable system. The 844 endpoints under this YAML-sourced import cover every NetBox model, so an automation pipeline can read inventory, allocate IPs, register devices, and inspect circuit terminations as part of a wider change workflow.

Use Cases

Patterns agents use NetBox API for, with concrete tasks.

★ Automated IP Allocation

Network engineering teams call /ipam/prefixes to pull the next available address when provisioning a device, then write it to /ipam/ip-addresses with the assigned object reference. The pattern replaces a shared spreadsheet with a queryable source of truth and keeps Terraform or Ansible runs idempotent.

Reserve the next available /32 from prefix 10.20.0.0/24 in NetBox and assign it to interface eth0 of device r1-edge.

Device Inventory Sync

Operations teams use /dcim/devices and the related rack and site endpoints to keep NetBox in sync with the physical environment. A scheduled job reads inventory from a network discovery tool, writes new devices to NetBox, updates serials, and reports drift so the next change request lands against accurate data.

Create a device named r1-edge in site dc-east, rack r-12, role edge-router, with the serial number ABC123.

Circuit and Provider Tracking

Network teams use the /circuits/ endpoints to record provider circuits and their terminations against sites and devices. The model captures circuit type, commit rate, and termination interface, so an outage on a provider circuit can be correlated to the affected sites without a separate tracker.

List all circuits terminating at site dc-east and return the provider name, circuit id, and commit rate for each.

AI Agent Integration via Jentic

An AI agent uses Jentic to query and update NetBox during a change workflow. Jentic exposes the dcim, ipam, circuits, and tenancy endpoints by intent, so an agent given a request to allocate an IP and add a device finds the right operations, supplies the model, and executes without hand-coding 844 endpoints.

Use Jentic to search for allocate next available ip in netbox, load the schema, and reserve the next /32 from prefix 10.20.0.0/24.

Key Endpoints

844 endpoints — jentic publishes the only available openapi specification for netbox api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/circuits/circuits/

List provider circuits

GET

/circuits/circuit-terminations/

List circuit terminations

GET

/circuits/circuit-types/

List circuit type definitions

GET

/circuits/provider-networks/

List provider networks

GET

/circuits/circuits/{id}/

Get a circuit by id

GET

/circuits/circuits/

List provider circuits

GET

/circuits/circuit-terminations/

List circuit terminations

GET

/circuits/circuit-types/

List circuit type definitions

GET

/circuits/provider-networks/

List provider networks

GET

/circuits/circuits/{id}/

Get a circuit by id

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The NetBox bearer token is stored encrypted in the Jentic MAXsystem vault. Agents receive scoped access at execution time and the raw token never enters the agent context.

Intent-based discovery

Agents search Jentic by intent (for example, allocate an ip in netbox) and Jentic returns the matching operation with its input schema, so the agent calls the right endpoint without traversing the 844-endpoint spec.

Time to first call

Direct NetBox integration: 1-2 weeks for token handling, model-aware filtering, and pagination across IPAM and DCIM. Through Jentic: under 1 hour to search, load, and execute.

FAQs

Specific to using NetBox API through Jentic.

Why is there no official OpenAPI spec for NetBox API?

NetBox publishes a Swagger UI on every install but does not maintain a standards-validated OpenAPI 3.0 spec as a release artefact. Jentic generates and maintains this spec so AI agents and developers can call NetBox via structured tooling kept current with each release. Get started at https://app.jentic.com/sign-up.

What authentication does the NetBox API use?

NetBox uses bearer token authentication — generate a token in the NetBox UI under your user profile and pass it as Authorization: Token <key>. Jentic stores the token encrypted in the MAXsystem vault so it is injected at execution time rather than passed through the agent context.

Can I allocate the next available IP from a NetBox prefix through the API?

Yes. The IPAM endpoints under /ipam/prefixes/ expose an available-ips action that returns the next free address inside a given prefix. Combine it with a write to /ipam/ip-addresses/ to allocate and assign the address atomically.

How do I list all devices at a site through Jentic?

Search Jentic for list netbox devices at a site, load the schema for the dcim devices endpoint, then execute with the site filter. The full flow is pip install jentic, search, load, execute.

What are the rate limits for the NetBox API?

NetBox does not impose API rate limits in the spec — limits depend on the operator's deployment. Treat large list calls as paginated and use brief=true for bulk reads to keep payload sizes small on heavily-populated installs.

Does this spec differ from the netbox.dev/main import?

No, the two imports cover the same NetBox 3.4 OpenAPI document — one was sourced from the JSON variant on apis.guru and the other from the YAML variant. Endpoint counts, paths, and methods are identical. Pick whichever matches your existing import path.