Skip to content

NetBox MCP Server — 608 tools

The NetBox DADL turns NetBox's API into an MCP server that Claude, GPT or any MCP-compatible agent can consume directly. One YAML file declares all 608 tools — virtual, circuit, device, module, vlan, contact, and more — and ToolMesh serves them at runtime. No Python boilerplate, no per-endpoint code, no separate MCP server process.

Below: the endpoint coverage matrix, a two-block ToolMesh setup, the full tool reference grouped by NetBox feature area, required credential scopes.

Source: NetBox REST API

Credits: Dunkel Cloud GmbH -- maintainerUpdated: 2026-08-15

Which NetBox endpoints are covered?

98% (608 of ~620 endpoints)

Focus: DCIM full v4: sites, site-groups, regions, locations, racks (with elevation, roles, types, reservations), manufacturers, device-types, device-roles, platforms, devices, modules, module-types, module-bays, device-bays, virtual-chassis, virtual-device-contexts, inventory-items, inventory-item-roles, interfaces, cables, cable-terminations, all port types (console, console-server, power, power-outlet, front, rear) with trace/paths actions, power-panels, power-feeds, mac-addresses, connected-device lookup, and the complete component-template family. IPAM full v4: prefixes (with available-prefixes/available-ips), ip-addresses, ip-ranges (with available-ips), vlans, vlan-groups (with available-vlans), vrfs, route-targets, aggregates, rirs, asns, asn-ranges (with available-asns), roles, services, service-templates, vlan-translation-policies, vlan-translation-rules, fhrp-groups, fhrp-group-assignments. Virtualization full v4: clusters, cluster-types, cluster-groups, virtual-machines, virtual-machine-types, vm-interfaces, virtual-disks. Tenancy full v4: tenants, tenant-groups, contacts, contact-roles, contact-groups, contact-assignments. Circuits full v4: providers, provider-accounts, provider-networks, circuit-types, circuits, circuit-terminations (with paths), circuit-groups, circuit-group-assignments, virtual-circuits, virtual-circuit-types, virtual-circuit-terminations. Wireless full v4: wireless-lan-groups, wireless-lans, wireless-links. VPN full v4: tunnel-groups, tunnels, tunnel-terminations, ike-proposals, ike-policies, ipsec-proposals, ipsec-policies, ipsec-profiles, l2vpns, l2vpn-terminations. Extras: tags, custom-fields, custom-field-choice-sets, custom-links, saved-filters, export-templates, journal-entries, object-changes, config-contexts, config-templates (+render), webhooks, event-rules, scripts (+run), bookmarks, notifications, notification-groups, subscriptions, image-attachments, dashboard. Users: users, groups, permissions, tokens (+provision). Core: data-sources (+sync), data-files, jobs, object-types, background-queues/workers/tasks.

Missing: Read-only listing of background-tasks with action endpoints (delete/requeue/enqueue/stop) -- rarely used outside debugging. Plugin-specific endpoints under /api/plugins/ -- those depend on installed plugins and are out of scope for a general DADL. table-configs, config-context-profiles, tagged-objects, and the authentication-check endpoint -- minor utility endpoints. Bulk update/delete on list endpoints (PUT/PATCH/DELETE on collections) -- prefer per-object operations in Code Mode.

Last reviewed: 2026-08-15

How do you configure the NetBox DADL?

  1. Log in to your NetBox instance as an admin user
  2. Navigate to your user profile (top-right) -> API Tokens
  3. Click 'Add a token' and configure permissions
  4. For full access: leave 'Write enabled' checked, no IP restrictions
  5. Copy the generated token -- it is shown only once (v2 tokens)
  6. v2 tokens start with 'nbt_' -- enter only the token value, ToolMesh adds the auth header automatically

Environment variable: CREDENTIAL_NETBOX_TOKEN

Authentication docs ↗

The url in backends.yaml must include /api (e.g. https://netbox.example.com/api). Enter only the raw token value (e.g. nbt_xxx) -- ToolMesh handles the Authorization header. Swagger docs at /api/schema/swagger-ui/.

How do you install the NetBox MCP server with ToolMesh?

Add to your backends.yaml:

- name: netbox
  transport: rest
  dadl: netbox.dadl
  url: "https://netbox.example.com/api"

Set the credential:

CREDENTIAL_NETBOX_TOKEN=your-token-here

What 608 tools does the NetBox DADL expose?

GETlist_sitesList all sites (data centers, offices, PoPs)
GETget_siteGet a specific site
POSTcreate_siteCreate a new site
PATCHupdate_siteUpdate a site
DELETEdelete_siteDelete a site
GETlist_regionsList all regions (geographic grouping of sites)
POSTcreate_regionCreate a region
GETget_regionGet a specific region
PATCHupdate_regionUpdate a region
DELETEdelete_regionDelete a region
GETlist_locationsList locations within sites (rooms, floors, cages)
POSTcreate_locationCreate a location within a site
GETget_locationGet a specific location
PATCHupdate_locationUpdate a location
DELETEdelete_locationDelete a location
GETlist_site_groupsList site groups (hierarchical grouping of sites, orthogonal to regions)
GETget_site_groupGet a specific site group
POSTcreate_site_groupCreate a site group
PATCHupdate_site_groupUpdate a site group
DELETEdelete_site_groupDelete a site group
GETlist_racksList all racks
GETget_rackGet a specific rack
POSTcreate_rackCreate a rack
PATCHupdate_rackUpdate a rack
DELETEdelete_rackDelete a rack
GETget_rack_elevationGet rack elevation -- returns the rack units with installed devices. Use ?render=svg for a graphical SVG rendering, default is JSON list of units.
GETlist_rack_rolesList rack roles (functional classification of racks)
GETget_rack_roleGet a specific rack role
POSTcreate_rack_roleCreate a rack role
PATCHupdate_rack_roleUpdate a rack role
DELETEdelete_rack_roleDelete a rack role
GETlist_rack_typesList rack types (reusable rack model definitions, NetBox 4.1+)
GETget_rack_typeGet a specific rack type
POSTcreate_rack_typeCreate a rack type
PATCHupdate_rack_typeUpdate a rack type
DELETEdelete_rack_typeDelete a rack type
GETlist_rack_reservationsList rack reservations (claimed rack units for future use)
GETget_rack_reservationGet a specific rack reservation
POSTcreate_rack_reservationReserve rack units for future installation
PATCHupdate_rack_reservationUpdate a rack reservation
DELETEdelete_rack_reservationDelete a rack reservation
GETlist_manufacturersList hardware manufacturers
POSTcreate_manufacturerCreate a hardware manufacturer
GETget_manufacturerGet a specific manufacturer
PATCHupdate_manufacturerUpdate a manufacturer
DELETEdelete_manufacturerDelete a manufacturer
GETlist_device_typesList device types (hardware models)
POSTcreate_device_typeCreate a device type (hardware model)
GETget_device_typeGet a specific device type
PATCHupdate_device_typeUpdate a device type
DELETEdelete_device_typeDelete a device type
GETlist_device_rolesList device roles (server, switch, router, firewall, etc.)
POSTcreate_device_roleCreate a device role
GETget_device_roleGet a specific device role
PATCHupdate_device_roleUpdate a device role
DELETEdelete_device_roleDelete a device role
GETlist_platformsList platforms (OS/firmware: Cisco IOS, Junos, Linux, etc.)
POSTcreate_platformCreate a platform (OS/firmware type)
GETget_platformGet a specific platform
PATCHupdate_platformUpdate a platform
DELETEdelete_platformDelete a platform
GETlist_devicesList all devices (servers, switches, routers, firewalls, etc.)
GETget_deviceGet a specific device with all details
POSTcreate_deviceCreate a new device
PATCHupdate_deviceUpdate a device -- fields, rack placement, primary IPs, out-of-band (OOB) management IP, virtual-chassis membership, geolocation. IP fields (primary_ip4/primary_ip6/oob_ip) take an ip-address ID that must already be assigned to an interface of this device.
DELETEdelete_deviceDelete a device
GETlist_module_typesList module types (reusable hardware module definitions, e.g. line cards)
GETget_module_typeGet a specific module type
POSTcreate_module_typeCreate a module type
PATCHupdate_module_typeUpdate a module type
DELETEdelete_module_typeDelete a module type
GETlist_module_type_profilesList module type profiles (schemas for module-type custom attributes, NetBox 4.3+)
GETget_module_type_profileGet a specific module type profile
POSTcreate_module_type_profileCreate a module type profile (JSON Schema describing module-type attributes)
PATCHupdate_module_type_profileUpdate a module type profile
DELETEdelete_module_type_profileDelete a module type profile
GETlist_modulesList installed modules (instances of module-types mounted in module-bays)
GETget_moduleGet a specific module
POSTcreate_moduleInstall a module into a module bay
PATCHupdate_moduleUpdate a module
DELETEdelete_moduleDelete a module
GETlist_module_baysList module bays (slots on a device that accept modules)
GETget_module_bayGet a specific module bay
POSTcreate_module_bayCreate a module bay on a device
PATCHupdate_module_bayUpdate a module bay
DELETEdelete_module_bayDelete a module bay
GETlist_device_baysList device bays (slots that contain child devices, e.g. blade chassis)
GETget_device_bayGet a specific device bay
POSTcreate_device_bayCreate a device bay
PATCHupdate_device_bayUpdate a device bay
DELETEdelete_device_bayDelete a device bay
GETlist_virtual_chassisList virtual chassis (logical grouping of stacked devices that share a single management plane)
GETget_virtual_chassisGet a specific virtual chassis
POSTcreate_virtual_chassisCreate a virtual chassis. Assign devices via PATCH /dcim/devices/ to set virtual_chassis and vc_position fields.
PATCHupdate_virtual_chassisUpdate a virtual chassis
DELETEdelete_virtual_chassisDelete a virtual chassis
GETlist_virtual_device_contextsList virtual device contexts (VDCs -- multiple logical contexts on one physical device, e.g. Cisco Nexus VDCs)
GETget_virtual_device_contextGet a specific VDC
POSTcreate_virtual_device_contextCreate a virtual device context
PATCHupdate_virtual_device_contextUpdate a virtual device context
DELETEdelete_virtual_device_contextDelete a virtual device context
GETlist_inventory_itemsList inventory items (line cards, fans, PSUs not modeled as full modules)
GETget_inventory_itemGet a specific inventory item
POSTcreate_inventory_itemCreate an inventory item on a device
PATCHupdate_inventory_itemUpdate an inventory item
DELETEdelete_inventory_itemDelete an inventory item
GETlist_inventory_item_rolesList inventory item roles (functional classification, e.g. CPU, PSU, Fan)
GETget_inventory_item_roleGet a specific inventory item role
POSTcreate_inventory_item_roleCreate an inventory item role
PATCHupdate_inventory_item_roleUpdate an inventory item role
DELETEdelete_inventory_item_roleDelete an inventory item role
GETlist_interfacesList device interfaces (physical and logical)
GETget_interfaceGet a specific interface
POSTcreate_interfaceCreate a device interface
PATCHupdate_interfaceUpdate a device interface. Nullable foreign keys and choice fields accept an explicit JSON null to clear -- omitting the field leaves it unchanged. Nullable params: untagged_vlan, lag, parent, bridge, vrf, primary_mac_address, mode, duplex. For M2M wireless_lans / tagged_vlans / tags pass [] to detach all.
DELETEdelete_interfaceDelete a device interface
GETlist_cablesList all cables connecting device components
GETget_cableGet a specific cable
POSTcreate_cableCreate a cable connection between device components
PATCHupdate_cableUpdate a cable
DELETEdelete_cableDelete a cable
GETlist_console_portsList device console ports
POSTcreate_console_portCreate a console port on a device
GETlist_power_portsList device power ports
POSTcreate_power_portCreate a power port on a device
GETlist_mac_addressesList MAC addresses
POSTcreate_mac_addressCreate a MAC address entry
GETget_mac_addressGet a specific MAC address entry
PATCHupdate_mac_addressUpdate a MAC address entry (reassign to different interface, change description)
DELETEdelete_mac_addressDelete a MAC address entry
GETget_console_portGet a specific console port
PATCHupdate_console_portUpdate a console port
DELETEdelete_console_portDelete a console port
GETtrace_console_portTrace the cable path from this console port to its far end (returns a list of cable segments)
GETlist_console_server_portsList console server ports (the server-side of console connections)
GETget_console_server_portGet a specific console server port
POSTcreate_console_server_portCreate a console server port
PATCHupdate_console_server_portUpdate a console server port
DELETEdelete_console_server_portDelete a console server port
GETget_power_portGet a specific power port
PATCHupdate_power_portUpdate a power port
DELETEdelete_power_portDelete a power port
GETlist_power_outletsList power outlets (sockets on a PDU or device that supply power to other devices)
GETget_power_outletGet a specific power outlet
POSTcreate_power_outletCreate a power outlet (typically on a PDU)
PATCHupdate_power_outletUpdate a power outlet
DELETEdelete_power_outletDelete a power outlet
GETlist_front_portsList front ports (patch panel front-side ports, paired with rear ports)
GETget_front_portGet a specific front port
POSTcreate_front_portCreate a front port on a patch panel (must reference a rear port)
PATCHupdate_front_portUpdate a front port
DELETEdelete_front_portDelete a front port
GETpaths_front_portList all cable paths that pass through this front port
GETlist_rear_portsList rear ports (patch panel rear-side ports, cabled to trunk lines)
GETget_rear_portGet a specific rear port
POSTcreate_rear_portCreate a rear port on a patch panel
PATCHupdate_rear_portUpdate a rear port
DELETEdelete_rear_portDelete a rear port
GETpaths_rear_portList all cable paths that pass through this rear port
GETtrace_interfaceTrace the cable path from this interface to its far end
GETtrace_power_portTrace the cable path from this power port
GETtrace_power_outletTrace the cable path from this power outlet
GETtrace_console_server_portTrace the cable path from this console server port
GETget_connected_deviceLookup the device connected to a given peer device/interface. Returns the device at the far end of the cable, or 404 if not connected.
GETlist_cable_terminationsList cable terminations (endpoints of cables -- the join between a cable and a port)
GETget_cable_terminationGet a specific cable termination
GETlist_power_panelsList power panels (the upstream source of power feeds at a site)
GETget_power_panelGet a specific power panel
POSTcreate_power_panelCreate a power panel
PATCHupdate_power_panelUpdate a power panel
DELETEdelete_power_panelDelete a power panel
GETlist_power_feedsList power feeds (the circuit from a power panel that supplies a rack)
GETget_power_feedGet a specific power feed
POSTcreate_power_feedCreate a power feed (circuit from a power panel to a rack)
PATCHupdate_power_feedUpdate a power feed
DELETEdelete_power_feedDelete a power feed
GETtrace_power_feedTrace the cable path from this power feed
GETlist_interface_templatesList interface templates on device-types and module-types
POSTcreate_interface_templateCreate an interface template. Must specify device_type OR module_type.
GETget_interface_templateGet a specific interface template
PATCHupdate_interface_templateUpdate an interface template
DELETEdelete_interface_templateDelete an interface template
GETlist_console_port_templatesList console port templates
POSTcreate_console_port_templateCreate a console port template
DELETEdelete_console_port_templateDelete a console port template
GETlist_console_server_port_templatesList console server port templates
POSTcreate_console_server_port_templateCreate a console server port template
DELETEdelete_console_server_port_templateDelete a console server port template
GETlist_power_port_templatesList power port templates
POSTcreate_power_port_templateCreate a power port template
DELETEdelete_power_port_templateDelete a power port template
GETlist_power_outlet_templatesList power outlet templates
POSTcreate_power_outlet_templateCreate a power outlet template
DELETEdelete_power_outlet_templateDelete a power outlet template
GETlist_front_port_templatesList front port templates
POSTcreate_front_port_templateCreate a front port template (must reference a rear-port-template)
DELETEdelete_front_port_templateDelete a front port template
GETlist_rear_port_templatesList rear port templates
POSTcreate_rear_port_templateCreate a rear port template
DELETEdelete_rear_port_templateDelete a rear port template
GETlist_module_bay_templatesList module bay templates
POSTcreate_module_bay_templateCreate a module bay template
DELETEdelete_module_bay_templateDelete a module bay template
GETlist_device_bay_templatesList device bay templates
POSTcreate_device_bay_templateCreate a device bay template
DELETEdelete_device_bay_templateDelete a device bay template
GETlist_inventory_item_templatesList inventory item templates
POSTcreate_inventory_item_templateCreate an inventory item template
DELETEdelete_inventory_item_templateDelete an inventory item template
GETlist_prefixesList IP prefixes (subnets). Results span ALL VRFs: overlapping private ranges (e.g. a customer VRF reusing an internal RFC1918 net) return look-alike rows -- check the vrf field and scope with vrf_id when a range is ambiguous.
GETget_prefixGet a specific prefix
POSTcreate_prefixCreate an IP prefix
PATCHupdate_prefixUpdate a prefix
DELETEdelete_prefixDelete a prefix
GETlist_available_ipsList available (unallocated) IPs within a prefix
GETlist_ip_addressesList all IP addresses. Results span ALL VRFs: the same private address can exist once globally and again inside a customer VRF -- check the vrf field on each row and scope with vrf_id when an address is ambiguous.
GETget_ip_addressGet a specific IP address
POSTcreate_ip_addressCreate an IP address
PATCHupdate_ip_addressUpdate an IP address
DELETEdelete_ip_addressDelete an IP address
GETlist_ip_rangesList IP ranges (continuous address ranges, e.g. DHCP pools)
POSTcreate_ip_rangeCreate an IP range
GETlist_vlansList all VLANs
GETget_vlanGet a specific VLAN
POSTcreate_vlanCreate a VLAN
PATCHupdate_vlanUpdate a VLAN
DELETEdelete_vlanDelete a VLAN
GETlist_vlan_groupsList VLAN groups
POSTcreate_vlan_groupCreate a VLAN group
GETget_vlan_groupGet a specific VLAN group
PATCHupdate_vlan_groupUpdate a VLAN group
DELETEdelete_vlan_groupDelete a VLAN group
GETlist_vrfsList all VRFs (Virtual Routing and Forwarding instances)
GETget_vrfGet a specific VRF
POSTcreate_vrfCreate a VRF
PATCHupdate_vrfUpdate a VRF
DELETEdelete_vrfDelete a VRF
GETlist_rirsList Regional Internet Registries (RIPE, ARIN, etc.)
POSTcreate_rirCreate a Regional Internet Registry
GETlist_aggregatesList aggregate prefixes (top-level allocations from RIRs)
POSTcreate_aggregateCreate an aggregate prefix (top-level RIR allocation)
GETlist_asnsList Autonomous System Numbers
POSTcreate_asnCreate an Autonomous System Number
GETlist_ipam_rolesList IPAM roles for prefixes and VLANs
POSTcreate_ipam_roleCreate an IPAM role for prefixes and VLANs
GETlist_servicesList services running on devices or VMs (DNS, HTTP, SSH, etc.). NetBox 4.x uses parent_object filters.
POSTcreate_serviceCreate a service entry on a device or VM. NetBox 4.x uses GenericForeignKey: set parent_object_type and parent_object_id instead of device/virtual_machine.
GETget_serviceGet a specific service
PATCHupdate_serviceUpdate a service. Use parent_object_type + parent_object_id to reassign (NetBox 4.x GenericForeignKey).
DELETEdelete_serviceDelete a service
GETlist_service_templatesList service templates (reusable service definitions, e.g. 'web-https')
GETget_service_templateGet a specific service template
POSTcreate_service_templateCreate a service template
PATCHupdate_service_templateUpdate a service template
DELETEdelete_service_templateDelete a service template
GETlist_route_targetsList BGP route targets (e.g. '65000:100', used for MPLS L3VPN import/export)
GETget_route_targetGet a specific route target
POSTcreate_route_targetCreate a route target. Assign to VRFs via vrf.import_targets / vrf.export_targets.
PATCHupdate_route_targetUpdate a route target
DELETEdelete_route_targetDelete a route target
GETlist_asn_rangesList ASN ranges (bounded ASN allocation pools)
GETget_asn_rangeGet a specific ASN range
POSTcreate_asn_rangeCreate an ASN range
PATCHupdate_asn_rangeUpdate an ASN range
DELETEdelete_asn_rangeDelete an ASN range
GETlist_available_asnsList the next unallocated ASNs within a range. POST to the same path to claim ASNs.
POSTclaim_asnClaim the next available ASN from a range and assign metadata
GETlist_available_prefixesList unallocated sub-prefixes within a prefix
POSTclaim_prefixCarve a new child prefix out of a parent. NetBox picks the next free block of prefix_length.
GETlist_available_ips_in_rangeList free IPs within an IP range
GETlist_available_vlansList the next unallocated VIDs in a VLAN group
POSTclaim_vlanClaim the next available VID from a VLAN group
GETget_ip_rangeGet a specific IP range
PATCHupdate_ip_rangeUpdate an IP range
DELETEdelete_ip_rangeDelete an IP range
GETget_aggregateGet a specific aggregate
PATCHupdate_aggregateUpdate an aggregate
DELETEdelete_aggregateDelete an aggregate
GETget_asnGet a specific ASN
PATCHupdate_asnUpdate an ASN
DELETEdelete_asnDelete an ASN
GETget_rirGet a specific RIR (Regional Internet Registry, e.g. RIPE, ARIN)
PATCHupdate_rirUpdate a RIR
DELETEdelete_rirDelete a RIR
GETlist_vlan_translation_policiesList VLAN translation policies (named sets of 1:1 VID mappings, NetBox 4.0+)
GETget_vlan_translation_policyGet a specific VLAN translation policy
POSTcreate_vlan_translation_policyCreate a VLAN translation policy
PATCHupdate_vlan_translation_policyUpdate a VLAN translation policy
DELETEdelete_vlan_translation_policyDelete a VLAN translation policy
GETlist_vlan_translation_rulesList VLAN translation rules (individual local-VID to remote-VID mappings within a policy)
GETget_vlan_translation_ruleGet a specific VLAN translation rule
POSTcreate_vlan_translation_ruleCreate a VLAN translation rule
PATCHupdate_vlan_translation_ruleUpdate a VLAN translation rule
DELETEdelete_vlan_translation_ruleDelete a VLAN translation rule
GETlist_fhrp_groupsList FHRP (First Hop Redundancy Protocol) groups. FHRP groups represent virtual IP failover configurations using VRRP, HSRP, GLBP, or CARP. Each group has a protocol, numeric group_id, and optional name. IP addresses are assigned to groups separately.
GETget_fhrp_groupGet a specific FHRP group by ID. Returns protocol, group_id, name, auth_type, auth_key, and assigned IP addresses.
POSTcreate_fhrp_groupCreate an FHRP group. Requires protocol and group_id. Virtual IP addresses can be created alongside the group or assigned afterward via IP address objects.
PATCHupdate_fhrp_groupUpdate an FHRP group.
DELETEdelete_fhrp_groupDelete an FHRP group. This also removes all group assignments.
GETlist_fhrp_group_assignmentsList FHRP group assignments — links between FHRP groups and device/VM interfaces. Each assignment has a priority (0-255) determining master/primary election.
GETget_fhrp_group_assignmentGet a specific FHRP group assignment by ID.
POSTcreate_fhrp_group_assignmentAssign an FHRP group to a device or VM interface. Priority (0-255) determines master/primary election — higher priority = more likely to be elected master.
PATCHupdate_fhrp_group_assignmentUpdate an FHRP group assignment (e.g. change priority or reassign to a different interface).
DELETEdelete_fhrp_group_assignmentDelete an FHRP group assignment — removes the interface from the FHRP group.
GETlist_cluster_typesList cluster types (VMware, Proxmox, XCP-ng, etc.)
POSTcreate_cluster_typeCreate a cluster type (e.g. VMware, Proxmox, Linode, XCP-ng)
GETlist_cluster_groupsList cluster groups
POSTcreate_cluster_groupCreate a cluster group
GETget_cluster_groupGet a specific cluster group
PATCHupdate_cluster_groupUpdate a cluster group
DELETEdelete_cluster_groupDelete a cluster group
GETlist_clustersList all virtualization clusters
GETget_clusterGet a specific cluster
POSTcreate_clusterCreate a virtualization cluster
PATCHupdate_clusterUpdate a cluster
DELETEdelete_clusterDelete a cluster
GETlist_virtual_machinesList all virtual machines
GETget_virtual_machineGet a specific virtual machine
POSTcreate_virtual_machineCreate a virtual machine
PATCHupdate_virtual_machineUpdate a virtual machine
DELETEdelete_virtual_machineDelete a virtual machine
GETlist_vm_interfacesList virtual machine interfaces
POSTcreate_vm_interfaceCreate a VM interface
GETget_vm_interfaceGet a specific VM interface
PATCHupdate_vm_interfaceUpdate a VM interface
DELETEdelete_vm_interfaceDelete a VM interface
GETlist_virtual_disksList virtual disks
POSTcreate_virtual_diskCreate a virtual disk
GETget_virtual_diskGet a specific virtual disk
PATCHupdate_virtual_diskUpdate a virtual disk
DELETEdelete_virtual_diskDelete a virtual disk
GETlist_virtual_machine_typesList virtual machine types (NetBox 4.2+, model definitions like AWS EC2 'm5.xlarge')
GETget_virtual_machine_typeGet a specific VM type
POSTcreate_virtual_machine_typeCreate a virtual machine type
PATCHupdate_virtual_machine_typeUpdate a virtual machine type
DELETEdelete_virtual_machine_typeDelete a virtual machine type
GETlist_tenantsList all tenants (customers, departments, teams)
GETget_tenantGet a specific tenant
POSTcreate_tenantCreate a tenant
PATCHupdate_tenantUpdate a tenant
DELETEdelete_tenantDelete a tenant
GETlist_tenant_groupsList tenant groups
POSTcreate_tenant_groupCreate a tenant group
GETget_tenant_groupGet a specific tenant group
PATCHupdate_tenant_groupUpdate a tenant group
DELETEdelete_tenant_groupDelete a tenant group
GETlist_contactsList all contacts
POSTcreate_contactCreate a contact
GETget_contactGet a specific contact
PATCHupdate_contactUpdate a contact
DELETEdelete_contactDelete a contact
GETlist_contact_rolesList contact roles (admin, NOC, billing, etc.)
POSTcreate_contact_roleCreate a contact role
GETget_contact_roleGet a specific contact role
PATCHupdate_contact_roleUpdate a contact role
DELETEdelete_contact_roleDelete a contact role
GETlist_contact_groupsList contact groups (hierarchical grouping of contacts)
GETget_contact_groupGet a specific contact group
POSTcreate_contact_groupCreate a contact group
PATCHupdate_contact_groupUpdate a contact group
DELETEdelete_contact_groupDelete a contact group
GETlist_contact_assignmentsList contact assignments (links between contacts and any NetBox object)
GETget_contact_assignmentGet a specific contact assignment
POSTcreate_contact_assignmentAssign a contact to an object (device, circuit, etc.)
PATCHupdate_contact_assignmentUpdate a contact assignment
DELETEdelete_contact_assignmentDelete a contact assignment
GETlist_providersList circuit providers (ISPs, carriers)
POSTcreate_providerCreate a circuit provider
GETget_providerGet a specific provider
PATCHupdate_providerUpdate a provider
DELETEdelete_providerDelete a provider
GETlist_circuit_typesList circuit types (Internet, MPLS, dark fiber, etc.)
POSTcreate_circuit_typeCreate a circuit type
GETget_circuit_typeGet a specific circuit type
PATCHupdate_circuit_typeUpdate a circuit type
DELETEdelete_circuit_typeDelete a circuit type
GETlist_circuitsList all circuits
GETget_circuitGet a specific circuit
POSTcreate_circuitCreate a circuit
PATCHupdate_circuitUpdate a circuit
DELETEdelete_circuitDelete a circuit
GETlist_circuit_terminationsList circuit terminations (A-side and Z-side endpoints)
POSTcreate_circuit_terminationCreate a circuit termination (A or Z side)
GETget_circuit_terminationGet a specific circuit termination
PATCHupdate_circuit_terminationUpdate a circuit termination
DELETEdelete_circuit_terminationDelete a circuit termination
GETpaths_circuit_terminationTrace cable paths from a circuit termination
GETlist_provider_accountsList provider accounts (a customer's account number with a provider)
GETget_provider_accountGet a specific provider account
POSTcreate_provider_accountCreate a provider account
PATCHupdate_provider_accountUpdate a provider account
DELETEdelete_provider_accountDelete a provider account
GETlist_provider_networksList provider networks (the far end of a circuit -- a provider's MPLS cloud, peering fabric, etc.)
GETget_provider_networkGet a specific provider network
POSTcreate_provider_networkCreate a provider network
PATCHupdate_provider_networkUpdate a provider network
DELETEdelete_provider_networkDelete a provider network
GETlist_circuit_groupsList circuit groups (logical grouping of related circuits, e.g. SD-WAN underlays)
GETget_circuit_groupGet a specific circuit group
POSTcreate_circuit_groupCreate a circuit group
PATCHupdate_circuit_groupUpdate a circuit group
DELETEdelete_circuit_groupDelete a circuit group
GETlist_circuit_group_assignmentsList circuit-to-group assignments with priorities
GETget_circuit_group_assignmentGet a specific circuit group assignment
POSTcreate_circuit_group_assignmentAssign a circuit (or virtual circuit) to a circuit group
PATCHupdate_circuit_group_assignmentUpdate a circuit group assignment
DELETEdelete_circuit_group_assignmentDelete a circuit group assignment
GETlist_virtual_circuit_typesList virtual circuit types (classification of virtual circuits, NetBox 4.2+)
GETget_virtual_circuit_typeGet a specific virtual circuit type
POSTcreate_virtual_circuit_typeCreate a virtual circuit type
PATCHupdate_virtual_circuit_typeUpdate a virtual circuit type
DELETEdelete_virtual_circuit_typeDelete a virtual circuit type
GETlist_virtual_circuitsList virtual circuits (logical end-to-end paths that run over a provider network, NetBox 4.2+)
GETget_virtual_circuitGet a specific virtual circuit
POSTcreate_virtual_circuitCreate a virtual circuit
PATCHupdate_virtual_circuitUpdate a virtual circuit
DELETEdelete_virtual_circuitDelete a virtual circuit
GETlist_virtual_circuit_terminationsList virtual circuit terminations (endpoints of virtual circuits on interfaces)
GETget_virtual_circuit_terminationGet a specific virtual circuit termination
POSTcreate_virtual_circuit_terminationTerminate a virtual circuit on a physical interface
PATCHupdate_virtual_circuit_terminationUpdate a virtual circuit termination
DELETEdelete_virtual_circuit_terminationDelete a virtual circuit termination
GETlist_wireless_lan_groupsList wireless LAN groups (hierarchical grouping of SSIDs)
GETget_wireless_lan_groupGet a specific wireless LAN group
POSTcreate_wireless_lan_groupCreate a wireless LAN group
PATCHupdate_wireless_lan_groupUpdate a wireless LAN group
DELETEdelete_wireless_lan_groupDelete a wireless LAN group
GETlist_wireless_lansList wireless LANs (SSIDs)
GETget_wireless_lanGet a specific wireless LAN
POSTcreate_wireless_lanCreate a wireless LAN (SSID)
PATCHupdate_wireless_lanUpdate a wireless LAN
DELETEdelete_wireless_lanDelete a wireless LAN
GETlist_wireless_linksList wireless point-to-point links
GETget_wireless_linkGet a specific wireless link
POSTcreate_wireless_linkCreate a wireless point-to-point link
PATCHupdate_wireless_linkUpdate a wireless link
DELETEdelete_wireless_linkDelete a wireless link
GETlist_tunnel_groupsList tunnel groups (logical grouping of VPN tunnels)
GETget_tunnel_groupGet a specific tunnel group
POSTcreate_tunnel_groupCreate a tunnel group
PATCHupdate_tunnel_groupUpdate a tunnel group
DELETEdelete_tunnel_groupDelete a tunnel group
GETlist_tunnelsList VPN tunnels
GETget_tunnelGet a specific tunnel
POSTcreate_tunnelCreate a VPN tunnel
PATCHupdate_tunnelUpdate a tunnel
DELETEdelete_tunnelDelete a tunnel
GETlist_tunnel_terminationsList tunnel terminations (per-side endpoints of a VPN tunnel)
GETget_tunnel_terminationGet a specific tunnel termination
POSTcreate_tunnel_terminationAdd a termination to a VPN tunnel
PATCHupdate_tunnel_terminationUpdate a tunnel termination
DELETEdelete_tunnel_terminationDelete a tunnel termination
GETlist_ike_proposalsList IKE proposals (encryption/authentication algorithm bundles for IKE phase 1)
GETget_ike_proposalGet a specific IKE proposal
POSTcreate_ike_proposalCreate an IKE proposal
PATCHupdate_ike_proposalUpdate an IKE proposal
DELETEdelete_ike_proposalDelete an IKE proposal
GETlist_ike_policiesList IKE policies (named groups of proposals + version + mode)
GETget_ike_policyGet a specific IKE policy
POSTcreate_ike_policyCreate an IKE policy
PATCHupdate_ike_policyUpdate an IKE policy
DELETEdelete_ike_policyDelete an IKE policy
GETlist_ipsec_proposalsList IPSec proposals (encryption/auth bundles for IPSec phase 2)
GETget_ipsec_proposalGet a specific IPSec proposal
POSTcreate_ipsec_proposalCreate an IPSec proposal
PATCHupdate_ipsec_proposalUpdate an IPSec proposal
DELETEdelete_ipsec_proposalDelete an IPSec proposal
GETlist_ipsec_policiesList IPSec policies (named bundles of IPSec proposals + PFS group)
GETget_ipsec_policyGet a specific IPSec policy
POSTcreate_ipsec_policyCreate an IPSec policy
PATCHupdate_ipsec_policyUpdate an IPSec policy
DELETEdelete_ipsec_policyDelete an IPSec policy
GETlist_ipsec_profilesList IPSec profiles (combination of IKE policy + IPSec policy + mode -- attach to a tunnel)
GETget_ipsec_profileGet a specific IPSec profile
POSTcreate_ipsec_profileCreate an IPSec profile
PATCHupdate_ipsec_profileUpdate an IPSec profile
DELETEdelete_ipsec_profileDelete an IPSec profile
GETlist_l2vpnsList L2VPN instances (VPLS, VXLAN, EVPN, etc.)
GETget_l2vpnGet a specific L2VPN
POSTcreate_l2vpnCreate an L2VPN instance
PATCHupdate_l2vpnUpdate an L2VPN
DELETEdelete_l2vpnDelete an L2VPN
GETlist_l2vpn_terminationsList L2VPN terminations (attachments of VLANs/interfaces/VRFs to an L2VPN)
GETget_l2vpn_terminationGet a specific L2VPN termination
POSTcreate_l2vpn_terminationAttach an interface, VLAN, or VRF to an L2VPN
PATCHupdate_l2vpn_terminationUpdate an L2VPN termination
DELETEdelete_l2vpn_terminationDelete an L2VPN termination
GETlist_tagsList all tags
POSTcreate_tagCreate a tag
GETget_tagGet a specific tag
PATCHupdate_tagUpdate a tag
DELETEdelete_tagDelete a tag
GETlist_custom_fieldsList all custom field definitions
GETget_custom_fieldGet a specific custom field definition
POSTcreate_custom_fieldCreate a custom field definition. Assign to object types via object_types array.
PATCHupdate_custom_fieldUpdate a custom field definition
DELETEdelete_custom_fieldDelete a custom field definition. WARNING: deletes all stored values.
GETlist_custom_field_choice_setsList all custom field choice sets
GETget_custom_field_choice_setGet a specific custom field choice set
POSTcreate_custom_field_choice_setCreate a custom field choice set for select/multiselect custom fields
PATCHupdate_custom_field_choice_setUpdate a custom field choice set
DELETEdelete_custom_field_choice_setDelete a custom field choice set. WARNING: breaks any custom fields referencing this set.
GETlist_object_changesList the change log — every create/update/delete on any NetBox object is recorded with timestamp, user, action, and pre/post-change snapshots. Use to audit who changed what and when.
GETlist_journal_entriesList journal entries (change notes on objects)
POSTcreate_journal_entryCreate a journal entry on an object
GETlist_config_contextsList configuration contexts (rendered config data for devices/VMs)
POSTcreate_config_contextCreate a configuration context
GETget_config_contextGet a specific config context
PATCHupdate_config_contextUpdate a config context
DELETEdelete_config_contextDelete a config context
GETget_journal_entryGet a specific journal entry
PATCHupdate_journal_entryUpdate a journal entry
DELETEdelete_journal_entryDelete a journal entry
GETlist_config_templatesList config templates (Jinja2 templates rendered against config-context data)
GETget_config_templateGet a specific config template
POSTcreate_config_templateCreate a config template
PATCHupdate_config_templateUpdate a config template
DELETEdelete_config_templateDelete a config template
POSTrender_config_templateRender a config template with the supplied context. Returns text/plain or JSON.
GETlist_webhooksList webhooks (HTTP callbacks that fire on object events)
GETget_webhookGet a specific webhook
POSTcreate_webhookCreate a webhook. Webhooks are now decoupled from triggers -- use event-rules to bind a webhook to a model + event.
PATCHupdate_webhookUpdate a webhook
DELETEdelete_webhookDelete a webhook
GETlist_event_rulesList event rules (binding: model + event type -> action target like webhook or script)
GETget_event_ruleGet a specific event rule
POSTcreate_event_ruleCreate an event rule
PATCHupdate_event_ruleUpdate an event rule
DELETEdelete_event_ruleDelete an event rule
GETlist_scriptsList installed custom scripts. NetBox 4.0+ merged reports into scripts. Each script has a module + name and is identified by id (or 'module.ClassName' string).
GETget_scriptGet script details (parameters schema, module info)
POSTrun_scriptExecute a custom script. Returns a job ID; poll /core/jobs/{job_id}/ for status. Data must match the script's declared parameters.
GETlist_export_templatesList export templates (Jinja2 templates that render lists of objects to CSV/JSON/text)
GETget_export_templateGet a specific export template
POSTcreate_export_templateCreate an export template
PATCHupdate_export_templateUpdate an export template
DELETEdelete_export_templateDelete an export template
GETlist_saved_filtersList saved filters (reusable URL query parameter sets per object type)
GETget_saved_filterGet a specific saved filter
POSTcreate_saved_filterCreate a saved filter
PATCHupdate_saved_filterUpdate a saved filter
DELETEdelete_saved_filterDelete a saved filter
GETlist_custom_linksList custom links (extra UI buttons shown on object pages)
GETget_custom_linkGet a specific custom link
POSTcreate_custom_linkCreate a custom link
PATCHupdate_custom_linkUpdate a custom link
DELETEdelete_custom_linkDelete a custom link
GETlist_bookmarksList bookmarks (user-specific bookmarks of NetBox objects)
GETget_bookmarkGet a specific bookmark
POSTcreate_bookmarkCreate a bookmark
DELETEdelete_bookmarkDelete a bookmark
GETlist_notificationsList notifications (in-app messages for users, NetBox 4.1+)
GETget_notificationGet a specific notification
POSTcreate_notificationCreate a notification (typically used by automation, not humans)
PATCHupdate_notificationMark notification as read by setting 'read' to a datetime
DELETEdelete_notificationDelete a notification
GETlist_notification_groupsList notification groups (sets of users + groups that receive event-rule notifications)
GETget_notification_groupGet a specific notification group
POSTcreate_notification_groupCreate a notification group
PATCHupdate_notification_groupUpdate a notification group
DELETEdelete_notification_groupDelete a notification group
GETlist_subscriptionsList subscriptions (per-user follow lists for specific objects)
GETget_subscriptionGet a specific subscription
POSTcreate_subscriptionSubscribe a user to events on an object
DELETEdelete_subscriptionDelete a subscription
GETlist_image_attachmentsList image attachments (rack diagrams, photos, etc. attached to NetBox objects)
GETget_image_attachmentGet a specific image attachment
POSTcreate_image_attachmentAttach an image to an object. Uses multipart/form-data with the image bytes.
PATCHupdate_image_attachmentUpdate image attachment metadata (name)
DELETEdelete_image_attachmentDelete an image attachment
GETget_dashboardGet the current user's dashboard configuration (singleton -- not a list endpoint)
PATCHupdate_dashboardUpdate the current user's dashboard layout
GETlist_usersList NetBox users. Admin-only endpoint.
GETget_userGet a specific user
POSTcreate_userCreate a NetBox user
PATCHupdate_userUpdate a user. Passing 'password' resets the password.
DELETEdelete_userDelete a user
GETlist_groupsList user groups
GETget_groupGet a specific group
POSTcreate_groupCreate a user group
PATCHupdate_groupUpdate a group
DELETEdelete_groupDelete a group
GETlist_permissionsList object permissions (per-model + per-action grants assigned to users/groups)
GETget_permissionGet a specific permission
POSTcreate_permissionCreate an object permission
PATCHupdate_permissionUpdate a permission
DELETEdelete_permissionDelete a permission
GETlist_tokensList API tokens. Admin sees all; regular users see only their own.
GETget_tokenGet a specific token (key shown only on create)
POSTcreate_tokenIssue a new API token for a user. The 'key' field in the response is shown only once.
PATCHupdate_tokenUpdate token metadata (description, expiry, allowed IPs)
DELETEdelete_tokenRevoke a token
POSTprovision_tokenIssue a token by username+password without an existing token. Bootstrap-only endpoint. Returns the new token in the response body.
GETlist_data_sourcesList core data sources (git/S3/local paths used to sync templates, scripts, contexts)
GETget_data_sourceGet a specific data source
POSTcreate_data_sourceCreate a data source
PATCHupdate_data_sourceUpdate a data source
DELETEdelete_data_sourceDelete a data source
POSTsync_data_sourceEnqueue a sync job for the data source. Returns job ID; poll /core/jobs/{id}/.
GETlist_data_filesList data files (read-only listing of files synced from data sources)
GETget_data_fileGet a specific data file (metadata + content)
GETlist_jobsList background jobs (script runs, data syncs, etc.)
GETget_jobGet a specific job (status, started/completed times, output data)
GETlist_object_typesList Django ContentTypes (app_label.model strings used in object_type fields)
GETget_object_typeGet a specific object type
GETlist_background_queuesList RQ background queues with statistics
GETlist_background_workersList active background workers
GETlist_background_tasksList background tasks (RQ jobs)