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
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.
How do you configure the NetBox DADL?
- Log in to your NetBox instance as an admin user
- Navigate to your user profile (top-right) -> API Tokens
- Click 'Add a token' and configure permissions
- For full access: leave 'Write enabled' checked, no IP restrictions
- Copy the generated token -- it is shown only once (v2 tokens)
- v2 tokens start with 'nbt_' -- enter only the token value, ToolMesh adds the auth header automatically
Environment variable: CREDENTIAL_NETBOX_TOKEN
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-hereWhat 608 tools does the NetBox DADL expose?
GETlist_sitesList all sites (data centers, offices, PoPs)GETget_siteGet a specific sitePOSTcreate_siteCreate a new sitePATCHupdate_siteUpdate a siteDELETEdelete_siteDelete a siteGETlist_regionsList all regions (geographic grouping of sites)POSTcreate_regionCreate a regionGETget_regionGet a specific regionPATCHupdate_regionUpdate a regionDELETEdelete_regionDelete a regionGETlist_locationsList locations within sites (rooms, floors, cages)POSTcreate_locationCreate a location within a siteGETget_locationGet a specific locationPATCHupdate_locationUpdate a locationDELETEdelete_locationDelete a locationGETlist_site_groupsList site groups (hierarchical grouping of sites, orthogonal to regions)GETget_site_groupGet a specific site groupPOSTcreate_site_groupCreate a site groupPATCHupdate_site_groupUpdate a site groupDELETEdelete_site_groupDelete a site groupGETlist_racksList all racksGETget_rackGet a specific rackPOSTcreate_rackCreate a rackPATCHupdate_rackUpdate a rackDELETEdelete_rackDelete a rackGETget_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 rolePOSTcreate_rack_roleCreate a rack rolePATCHupdate_rack_roleUpdate a rack roleDELETEdelete_rack_roleDelete a rack roleGETlist_rack_typesList rack types (reusable rack model definitions, NetBox 4.1+)GETget_rack_typeGet a specific rack typePOSTcreate_rack_typeCreate a rack typePATCHupdate_rack_typeUpdate a rack typeDELETEdelete_rack_typeDelete a rack typeGETlist_rack_reservationsList rack reservations (claimed rack units for future use)GETget_rack_reservationGet a specific rack reservationPOSTcreate_rack_reservationReserve rack units for future installationPATCHupdate_rack_reservationUpdate a rack reservationDELETEdelete_rack_reservationDelete a rack reservationGETlist_manufacturersList hardware manufacturersPOSTcreate_manufacturerCreate a hardware manufacturerGETget_manufacturerGet a specific manufacturerPATCHupdate_manufacturerUpdate a manufacturerDELETEdelete_manufacturerDelete a manufacturerGETlist_device_typesList device types (hardware models)POSTcreate_device_typeCreate a device type (hardware model)GETget_device_typeGet a specific device typePATCHupdate_device_typeUpdate a device typeDELETEdelete_device_typeDelete a device typeGETlist_device_rolesList device roles (server, switch, router, firewall, etc.)POSTcreate_device_roleCreate a device roleGETget_device_roleGet a specific device rolePATCHupdate_device_roleUpdate a device roleDELETEdelete_device_roleDelete a device roleGETlist_platformsList platforms (OS/firmware: Cisco IOS, Junos, Linux, etc.)POSTcreate_platformCreate a platform (OS/firmware type)GETget_platformGet a specific platformPATCHupdate_platformUpdate a platformDELETEdelete_platformDelete a platformGETlist_devicesList all devices (servers, switches, routers, firewalls, etc.)GETget_deviceGet a specific device with all detailsPOSTcreate_deviceCreate a new devicePATCHupdate_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 deviceGETlist_module_typesList module types (reusable hardware module definitions, e.g. line cards)GETget_module_typeGet a specific module typePOSTcreate_module_typeCreate a module typePATCHupdate_module_typeUpdate a module typeDELETEdelete_module_typeDelete a module typeGETlist_module_type_profilesList module type profiles (schemas for module-type custom attributes, NetBox 4.3+)GETget_module_type_profileGet a specific module type profilePOSTcreate_module_type_profileCreate a module type profile (JSON Schema describing module-type attributes)PATCHupdate_module_type_profileUpdate a module type profileDELETEdelete_module_type_profileDelete a module type profileGETlist_modulesList installed modules (instances of module-types mounted in module-bays)GETget_moduleGet a specific modulePOSTcreate_moduleInstall a module into a module bayPATCHupdate_moduleUpdate a moduleDELETEdelete_moduleDelete a moduleGETlist_module_baysList module bays (slots on a device that accept modules)GETget_module_bayGet a specific module bayPOSTcreate_module_bayCreate a module bay on a devicePATCHupdate_module_bayUpdate a module bayDELETEdelete_module_bayDelete a module bayGETlist_device_baysList device bays (slots that contain child devices, e.g. blade chassis)GETget_device_bayGet a specific device bayPOSTcreate_device_bayCreate a device bayPATCHupdate_device_bayUpdate a device bayDELETEdelete_device_bayDelete a device bayGETlist_virtual_chassisList virtual chassis (logical grouping of stacked devices that share a single management plane)GETget_virtual_chassisGet a specific virtual chassisPOSTcreate_virtual_chassisCreate a virtual chassis. Assign devices via PATCH /dcim/devices/ to set virtual_chassis and vc_position fields.PATCHupdate_virtual_chassisUpdate a virtual chassisDELETEdelete_virtual_chassisDelete a virtual chassisGETlist_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 VDCPOSTcreate_virtual_device_contextCreate a virtual device contextPATCHupdate_virtual_device_contextUpdate a virtual device contextDELETEdelete_virtual_device_contextDelete a virtual device contextGETlist_inventory_itemsList inventory items (line cards, fans, PSUs not modeled as full modules)GETget_inventory_itemGet a specific inventory itemPOSTcreate_inventory_itemCreate an inventory item on a devicePATCHupdate_inventory_itemUpdate an inventory itemDELETEdelete_inventory_itemDelete an inventory itemGETlist_inventory_item_rolesList inventory item roles (functional classification, e.g. CPU, PSU, Fan)GETget_inventory_item_roleGet a specific inventory item rolePOSTcreate_inventory_item_roleCreate an inventory item rolePATCHupdate_inventory_item_roleUpdate an inventory item roleDELETEdelete_inventory_item_roleDelete an inventory item roleGETlist_interfacesList device interfaces (physical and logical)GETget_interfaceGet a specific interfacePOSTcreate_interfaceCreate a device interfacePATCHupdate_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 interfaceGETlist_cablesList all cables connecting device componentsGETget_cableGet a specific cablePOSTcreate_cableCreate a cable connection between device componentsPATCHupdate_cableUpdate a cableDELETEdelete_cableDelete a cableGETlist_console_portsList device console portsPOSTcreate_console_portCreate a console port on a deviceGETlist_power_portsList device power portsPOSTcreate_power_portCreate a power port on a deviceGETlist_mac_addressesList MAC addressesPOSTcreate_mac_addressCreate a MAC address entryGETget_mac_addressGet a specific MAC address entryPATCHupdate_mac_addressUpdate a MAC address entry (reassign to different interface, change description)DELETEdelete_mac_addressDelete a MAC address entryGETget_console_portGet a specific console portPATCHupdate_console_portUpdate a console portDELETEdelete_console_portDelete a console portGETtrace_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 portPOSTcreate_console_server_portCreate a console server portPATCHupdate_console_server_portUpdate a console server portDELETEdelete_console_server_portDelete a console server portGETget_power_portGet a specific power portPATCHupdate_power_portUpdate a power portDELETEdelete_power_portDelete a power portGETlist_power_outletsList power outlets (sockets on a PDU or device that supply power to other devices)GETget_power_outletGet a specific power outletPOSTcreate_power_outletCreate a power outlet (typically on a PDU)PATCHupdate_power_outletUpdate a power outletDELETEdelete_power_outletDelete a power outletGETlist_front_portsList front ports (patch panel front-side ports, paired with rear ports)GETget_front_portGet a specific front portPOSTcreate_front_portCreate a front port on a patch panel (must reference a rear port)PATCHupdate_front_portUpdate a front portDELETEdelete_front_portDelete a front portGETpaths_front_portList all cable paths that pass through this front portGETlist_rear_portsList rear ports (patch panel rear-side ports, cabled to trunk lines)GETget_rear_portGet a specific rear portPOSTcreate_rear_portCreate a rear port on a patch panelPATCHupdate_rear_portUpdate a rear portDELETEdelete_rear_portDelete a rear portGETpaths_rear_portList all cable paths that pass through this rear portGETtrace_interfaceTrace the cable path from this interface to its far endGETtrace_power_portTrace the cable path from this power portGETtrace_power_outletTrace the cable path from this power outletGETtrace_console_server_portTrace the cable path from this console server portGETget_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 terminationGETlist_power_panelsList power panels (the upstream source of power feeds at a site)GETget_power_panelGet a specific power panelPOSTcreate_power_panelCreate a power panelPATCHupdate_power_panelUpdate a power panelDELETEdelete_power_panelDelete a power panelGETlist_power_feedsList power feeds (the circuit from a power panel that supplies a rack)GETget_power_feedGet a specific power feedPOSTcreate_power_feedCreate a power feed (circuit from a power panel to a rack)PATCHupdate_power_feedUpdate a power feedDELETEdelete_power_feedDelete a power feedGETtrace_power_feedTrace the cable path from this power feedGETlist_interface_templatesList interface templates on device-types and module-typesPOSTcreate_interface_templateCreate an interface template. Must specify device_type OR module_type.GETget_interface_templateGet a specific interface templatePATCHupdate_interface_templateUpdate an interface templateDELETEdelete_interface_templateDelete an interface templateGETlist_console_port_templatesList console port templatesPOSTcreate_console_port_templateCreate a console port templateDELETEdelete_console_port_templateDelete a console port templateGETlist_console_server_port_templatesList console server port templatesPOSTcreate_console_server_port_templateCreate a console server port templateDELETEdelete_console_server_port_templateDelete a console server port templateGETlist_power_port_templatesList power port templatesPOSTcreate_power_port_templateCreate a power port templateDELETEdelete_power_port_templateDelete a power port templateGETlist_power_outlet_templatesList power outlet templatesPOSTcreate_power_outlet_templateCreate a power outlet templateDELETEdelete_power_outlet_templateDelete a power outlet templateGETlist_front_port_templatesList front port templatesPOSTcreate_front_port_templateCreate a front port template (must reference a rear-port-template)DELETEdelete_front_port_templateDelete a front port templateGETlist_rear_port_templatesList rear port templatesPOSTcreate_rear_port_templateCreate a rear port templateDELETEdelete_rear_port_templateDelete a rear port templateGETlist_module_bay_templatesList module bay templatesPOSTcreate_module_bay_templateCreate a module bay templateDELETEdelete_module_bay_templateDelete a module bay templateGETlist_device_bay_templatesList device bay templatesPOSTcreate_device_bay_templateCreate a device bay templateDELETEdelete_device_bay_templateDelete a device bay templateGETlist_inventory_item_templatesList inventory item templatesPOSTcreate_inventory_item_templateCreate an inventory item templateDELETEdelete_inventory_item_templateDelete an inventory item templateGETlist_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 prefixPOSTcreate_prefixCreate an IP prefixPATCHupdate_prefixUpdate a prefixDELETEdelete_prefixDelete a prefixGETlist_available_ipsList available (unallocated) IPs within a prefixGETlist_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 addressPOSTcreate_ip_addressCreate an IP addressPATCHupdate_ip_addressUpdate an IP addressDELETEdelete_ip_addressDelete an IP addressGETlist_ip_rangesList IP ranges (continuous address ranges, e.g. DHCP pools)POSTcreate_ip_rangeCreate an IP rangeGETlist_vlansList all VLANsGETget_vlanGet a specific VLANPOSTcreate_vlanCreate a VLANPATCHupdate_vlanUpdate a VLANDELETEdelete_vlanDelete a VLANGETlist_vlan_groupsList VLAN groupsPOSTcreate_vlan_groupCreate a VLAN groupGETget_vlan_groupGet a specific VLAN groupPATCHupdate_vlan_groupUpdate a VLAN groupDELETEdelete_vlan_groupDelete a VLAN groupGETlist_vrfsList all VRFs (Virtual Routing and Forwarding instances)GETget_vrfGet a specific VRFPOSTcreate_vrfCreate a VRFPATCHupdate_vrfUpdate a VRFDELETEdelete_vrfDelete a VRFGETlist_rirsList Regional Internet Registries (RIPE, ARIN, etc.)POSTcreate_rirCreate a Regional Internet RegistryGETlist_aggregatesList aggregate prefixes (top-level allocations from RIRs)POSTcreate_aggregateCreate an aggregate prefix (top-level RIR allocation)GETlist_asnsList Autonomous System NumbersPOSTcreate_asnCreate an Autonomous System NumberGETlist_ipam_rolesList IPAM roles for prefixes and VLANsPOSTcreate_ipam_roleCreate an IPAM role for prefixes and VLANsGETlist_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 servicePATCHupdate_serviceUpdate a service. Use parent_object_type + parent_object_id to reassign (NetBox 4.x GenericForeignKey).DELETEdelete_serviceDelete a serviceGETlist_service_templatesList service templates (reusable service definitions, e.g. 'web-https')GETget_service_templateGet a specific service templatePOSTcreate_service_templateCreate a service templatePATCHupdate_service_templateUpdate a service templateDELETEdelete_service_templateDelete a service templateGETlist_route_targetsList BGP route targets (e.g. '65000:100', used for MPLS L3VPN import/export)GETget_route_targetGet a specific route targetPOSTcreate_route_targetCreate a route target. Assign to VRFs via vrf.import_targets / vrf.export_targets.PATCHupdate_route_targetUpdate a route targetDELETEdelete_route_targetDelete a route targetGETlist_asn_rangesList ASN ranges (bounded ASN allocation pools)GETget_asn_rangeGet a specific ASN rangePOSTcreate_asn_rangeCreate an ASN rangePATCHupdate_asn_rangeUpdate an ASN rangeDELETEdelete_asn_rangeDelete an ASN rangeGETlist_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 metadataGETlist_available_prefixesList unallocated sub-prefixes within a prefixPOSTclaim_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 rangeGETlist_available_vlansList the next unallocated VIDs in a VLAN groupPOSTclaim_vlanClaim the next available VID from a VLAN groupGETget_ip_rangeGet a specific IP rangePATCHupdate_ip_rangeUpdate an IP rangeDELETEdelete_ip_rangeDelete an IP rangeGETget_aggregateGet a specific aggregatePATCHupdate_aggregateUpdate an aggregateDELETEdelete_aggregateDelete an aggregateGETget_asnGet a specific ASNPATCHupdate_asnUpdate an ASNDELETEdelete_asnDelete an ASNGETget_rirGet a specific RIR (Regional Internet Registry, e.g. RIPE, ARIN)PATCHupdate_rirUpdate a RIRDELETEdelete_rirDelete a RIRGETlist_vlan_translation_policiesList VLAN translation policies (named sets of 1:1 VID mappings, NetBox 4.0+)GETget_vlan_translation_policyGet a specific VLAN translation policyPOSTcreate_vlan_translation_policyCreate a VLAN translation policyPATCHupdate_vlan_translation_policyUpdate a VLAN translation policyDELETEdelete_vlan_translation_policyDelete a VLAN translation policyGETlist_vlan_translation_rulesList VLAN translation rules (individual local-VID to remote-VID mappings within a policy)GETget_vlan_translation_ruleGet a specific VLAN translation rulePOSTcreate_vlan_translation_ruleCreate a VLAN translation rulePATCHupdate_vlan_translation_ruleUpdate a VLAN translation ruleDELETEdelete_vlan_translation_ruleDelete a VLAN translation ruleGETlist_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 groupsPOSTcreate_cluster_groupCreate a cluster groupGETget_cluster_groupGet a specific cluster groupPATCHupdate_cluster_groupUpdate a cluster groupDELETEdelete_cluster_groupDelete a cluster groupGETlist_clustersList all virtualization clustersGETget_clusterGet a specific clusterPOSTcreate_clusterCreate a virtualization clusterPATCHupdate_clusterUpdate a clusterDELETEdelete_clusterDelete a clusterGETlist_virtual_machinesList all virtual machinesGETget_virtual_machineGet a specific virtual machinePOSTcreate_virtual_machineCreate a virtual machinePATCHupdate_virtual_machineUpdate a virtual machineDELETEdelete_virtual_machineDelete a virtual machineGETlist_vm_interfacesList virtual machine interfacesPOSTcreate_vm_interfaceCreate a VM interfaceGETget_vm_interfaceGet a specific VM interfacePATCHupdate_vm_interfaceUpdate a VM interfaceDELETEdelete_vm_interfaceDelete a VM interfaceGETlist_virtual_disksList virtual disksPOSTcreate_virtual_diskCreate a virtual diskGETget_virtual_diskGet a specific virtual diskPATCHupdate_virtual_diskUpdate a virtual diskDELETEdelete_virtual_diskDelete a virtual diskGETlist_virtual_machine_typesList virtual machine types (NetBox 4.2+, model definitions like AWS EC2 'm5.xlarge')GETget_virtual_machine_typeGet a specific VM typePOSTcreate_virtual_machine_typeCreate a virtual machine typePATCHupdate_virtual_machine_typeUpdate a virtual machine typeDELETEdelete_virtual_machine_typeDelete a virtual machine typeGETlist_tenantsList all tenants (customers, departments, teams)GETget_tenantGet a specific tenantPOSTcreate_tenantCreate a tenantPATCHupdate_tenantUpdate a tenantDELETEdelete_tenantDelete a tenantGETlist_tenant_groupsList tenant groupsPOSTcreate_tenant_groupCreate a tenant groupGETget_tenant_groupGet a specific tenant groupPATCHupdate_tenant_groupUpdate a tenant groupDELETEdelete_tenant_groupDelete a tenant groupGETlist_contactsList all contactsPOSTcreate_contactCreate a contactGETget_contactGet a specific contactPATCHupdate_contactUpdate a contactDELETEdelete_contactDelete a contactGETlist_contact_rolesList contact roles (admin, NOC, billing, etc.)POSTcreate_contact_roleCreate a contact roleGETget_contact_roleGet a specific contact rolePATCHupdate_contact_roleUpdate a contact roleDELETEdelete_contact_roleDelete a contact roleGETlist_contact_groupsList contact groups (hierarchical grouping of contacts)GETget_contact_groupGet a specific contact groupPOSTcreate_contact_groupCreate a contact groupPATCHupdate_contact_groupUpdate a contact groupDELETEdelete_contact_groupDelete a contact groupGETlist_contact_assignmentsList contact assignments (links between contacts and any NetBox object)GETget_contact_assignmentGet a specific contact assignmentPOSTcreate_contact_assignmentAssign a contact to an object (device, circuit, etc.)PATCHupdate_contact_assignmentUpdate a contact assignmentDELETEdelete_contact_assignmentDelete a contact assignmentGETlist_providersList circuit providers (ISPs, carriers)POSTcreate_providerCreate a circuit providerGETget_providerGet a specific providerPATCHupdate_providerUpdate a providerDELETEdelete_providerDelete a providerGETlist_circuit_typesList circuit types (Internet, MPLS, dark fiber, etc.)POSTcreate_circuit_typeCreate a circuit typeGETget_circuit_typeGet a specific circuit typePATCHupdate_circuit_typeUpdate a circuit typeDELETEdelete_circuit_typeDelete a circuit typeGETlist_circuitsList all circuitsGETget_circuitGet a specific circuitPOSTcreate_circuitCreate a circuitPATCHupdate_circuitUpdate a circuitDELETEdelete_circuitDelete a circuitGETlist_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 terminationPATCHupdate_circuit_terminationUpdate a circuit terminationDELETEdelete_circuit_terminationDelete a circuit terminationGETpaths_circuit_terminationTrace cable paths from a circuit terminationGETlist_provider_accountsList provider accounts (a customer's account number with a provider)GETget_provider_accountGet a specific provider accountPOSTcreate_provider_accountCreate a provider accountPATCHupdate_provider_accountUpdate a provider accountDELETEdelete_provider_accountDelete a provider accountGETlist_provider_networksList provider networks (the far end of a circuit -- a provider's MPLS cloud, peering fabric, etc.)GETget_provider_networkGet a specific provider networkPOSTcreate_provider_networkCreate a provider networkPATCHupdate_provider_networkUpdate a provider networkDELETEdelete_provider_networkDelete a provider networkGETlist_circuit_groupsList circuit groups (logical grouping of related circuits, e.g. SD-WAN underlays)GETget_circuit_groupGet a specific circuit groupPOSTcreate_circuit_groupCreate a circuit groupPATCHupdate_circuit_groupUpdate a circuit groupDELETEdelete_circuit_groupDelete a circuit groupGETlist_circuit_group_assignmentsList circuit-to-group assignments with prioritiesGETget_circuit_group_assignmentGet a specific circuit group assignmentPOSTcreate_circuit_group_assignmentAssign a circuit (or virtual circuit) to a circuit groupPATCHupdate_circuit_group_assignmentUpdate a circuit group assignmentDELETEdelete_circuit_group_assignmentDelete a circuit group assignmentGETlist_virtual_circuit_typesList virtual circuit types (classification of virtual circuits, NetBox 4.2+)GETget_virtual_circuit_typeGet a specific virtual circuit typePOSTcreate_virtual_circuit_typeCreate a virtual circuit typePATCHupdate_virtual_circuit_typeUpdate a virtual circuit typeDELETEdelete_virtual_circuit_typeDelete a virtual circuit typeGETlist_virtual_circuitsList virtual circuits (logical end-to-end paths that run over a provider network, NetBox 4.2+)GETget_virtual_circuitGet a specific virtual circuitPOSTcreate_virtual_circuitCreate a virtual circuitPATCHupdate_virtual_circuitUpdate a virtual circuitDELETEdelete_virtual_circuitDelete a virtual circuitGETlist_virtual_circuit_terminationsList virtual circuit terminations (endpoints of virtual circuits on interfaces)GETget_virtual_circuit_terminationGet a specific virtual circuit terminationPOSTcreate_virtual_circuit_terminationTerminate a virtual circuit on a physical interfacePATCHupdate_virtual_circuit_terminationUpdate a virtual circuit terminationDELETEdelete_virtual_circuit_terminationDelete a virtual circuit terminationGETlist_wireless_lan_groupsList wireless LAN groups (hierarchical grouping of SSIDs)GETget_wireless_lan_groupGet a specific wireless LAN groupPOSTcreate_wireless_lan_groupCreate a wireless LAN groupPATCHupdate_wireless_lan_groupUpdate a wireless LAN groupDELETEdelete_wireless_lan_groupDelete a wireless LAN groupGETlist_wireless_lansList wireless LANs (SSIDs)GETget_wireless_lanGet a specific wireless LANPOSTcreate_wireless_lanCreate a wireless LAN (SSID)PATCHupdate_wireless_lanUpdate a wireless LANDELETEdelete_wireless_lanDelete a wireless LANGETlist_wireless_linksList wireless point-to-point linksGETget_wireless_linkGet a specific wireless linkPOSTcreate_wireless_linkCreate a wireless point-to-point linkPATCHupdate_wireless_linkUpdate a wireless linkDELETEdelete_wireless_linkDelete a wireless linkGETlist_tunnel_groupsList tunnel groups (logical grouping of VPN tunnels)GETget_tunnel_groupGet a specific tunnel groupPOSTcreate_tunnel_groupCreate a tunnel groupPATCHupdate_tunnel_groupUpdate a tunnel groupDELETEdelete_tunnel_groupDelete a tunnel groupGETlist_tunnelsList VPN tunnelsGETget_tunnelGet a specific tunnelPOSTcreate_tunnelCreate a VPN tunnelPATCHupdate_tunnelUpdate a tunnelDELETEdelete_tunnelDelete a tunnelGETlist_tunnel_terminationsList tunnel terminations (per-side endpoints of a VPN tunnel)GETget_tunnel_terminationGet a specific tunnel terminationPOSTcreate_tunnel_terminationAdd a termination to a VPN tunnelPATCHupdate_tunnel_terminationUpdate a tunnel terminationDELETEdelete_tunnel_terminationDelete a tunnel terminationGETlist_ike_proposalsList IKE proposals (encryption/authentication algorithm bundles for IKE phase 1)GETget_ike_proposalGet a specific IKE proposalPOSTcreate_ike_proposalCreate an IKE proposalPATCHupdate_ike_proposalUpdate an IKE proposalDELETEdelete_ike_proposalDelete an IKE proposalGETlist_ike_policiesList IKE policies (named groups of proposals + version + mode)GETget_ike_policyGet a specific IKE policyPOSTcreate_ike_policyCreate an IKE policyPATCHupdate_ike_policyUpdate an IKE policyDELETEdelete_ike_policyDelete an IKE policyGETlist_ipsec_proposalsList IPSec proposals (encryption/auth bundles for IPSec phase 2)GETget_ipsec_proposalGet a specific IPSec proposalPOSTcreate_ipsec_proposalCreate an IPSec proposalPATCHupdate_ipsec_proposalUpdate an IPSec proposalDELETEdelete_ipsec_proposalDelete an IPSec proposalGETlist_ipsec_policiesList IPSec policies (named bundles of IPSec proposals + PFS group)GETget_ipsec_policyGet a specific IPSec policyPOSTcreate_ipsec_policyCreate an IPSec policyPATCHupdate_ipsec_policyUpdate an IPSec policyDELETEdelete_ipsec_policyDelete an IPSec policyGETlist_ipsec_profilesList IPSec profiles (combination of IKE policy + IPSec policy + mode -- attach to a tunnel)GETget_ipsec_profileGet a specific IPSec profilePOSTcreate_ipsec_profileCreate an IPSec profilePATCHupdate_ipsec_profileUpdate an IPSec profileDELETEdelete_ipsec_profileDelete an IPSec profileGETlist_l2vpnsList L2VPN instances (VPLS, VXLAN, EVPN, etc.)GETget_l2vpnGet a specific L2VPNPOSTcreate_l2vpnCreate an L2VPN instancePATCHupdate_l2vpnUpdate an L2VPNDELETEdelete_l2vpnDelete an L2VPNGETlist_l2vpn_terminationsList L2VPN terminations (attachments of VLANs/interfaces/VRFs to an L2VPN)GETget_l2vpn_terminationGet a specific L2VPN terminationPOSTcreate_l2vpn_terminationAttach an interface, VLAN, or VRF to an L2VPNPATCHupdate_l2vpn_terminationUpdate an L2VPN terminationDELETEdelete_l2vpn_terminationDelete an L2VPN terminationGETlist_tagsList all tagsPOSTcreate_tagCreate a tagGETget_tagGet a specific tagPATCHupdate_tagUpdate a tagDELETEdelete_tagDelete a tagGETlist_custom_fieldsList all custom field definitionsGETget_custom_fieldGet a specific custom field definitionPOSTcreate_custom_fieldCreate a custom field definition. Assign to object types via object_types array.PATCHupdate_custom_fieldUpdate a custom field definitionDELETEdelete_custom_fieldDelete a custom field definition. WARNING: deletes all stored values.GETlist_custom_field_choice_setsList all custom field choice setsGETget_custom_field_choice_setGet a specific custom field choice setPOSTcreate_custom_field_choice_setCreate a custom field choice set for select/multiselect custom fieldsPATCHupdate_custom_field_choice_setUpdate a custom field choice setDELETEdelete_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 objectGETlist_config_contextsList configuration contexts (rendered config data for devices/VMs)POSTcreate_config_contextCreate a configuration contextGETget_config_contextGet a specific config contextPATCHupdate_config_contextUpdate a config contextDELETEdelete_config_contextDelete a config contextGETget_journal_entryGet a specific journal entryPATCHupdate_journal_entryUpdate a journal entryDELETEdelete_journal_entryDelete a journal entryGETlist_config_templatesList config templates (Jinja2 templates rendered against config-context data)GETget_config_templateGet a specific config templatePOSTcreate_config_templateCreate a config templatePATCHupdate_config_templateUpdate a config templateDELETEdelete_config_templateDelete a config templatePOSTrender_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 webhookPOSTcreate_webhookCreate a webhook. Webhooks are now decoupled from triggers -- use event-rules to bind a webhook to a model + event.PATCHupdate_webhookUpdate a webhookDELETEdelete_webhookDelete a webhookGETlist_event_rulesList event rules (binding: model + event type -> action target like webhook or script)GETget_event_ruleGet a specific event rulePOSTcreate_event_ruleCreate an event rulePATCHupdate_event_ruleUpdate an event ruleDELETEdelete_event_ruleDelete an event ruleGETlist_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 templatePOSTcreate_export_templateCreate an export templatePATCHupdate_export_templateUpdate an export templateDELETEdelete_export_templateDelete an export templateGETlist_saved_filtersList saved filters (reusable URL query parameter sets per object type)GETget_saved_filterGet a specific saved filterPOSTcreate_saved_filterCreate a saved filterPATCHupdate_saved_filterUpdate a saved filterDELETEdelete_saved_filterDelete a saved filterGETlist_custom_linksList custom links (extra UI buttons shown on object pages)GETget_custom_linkGet a specific custom linkPOSTcreate_custom_linkCreate a custom linkPATCHupdate_custom_linkUpdate a custom linkDELETEdelete_custom_linkDelete a custom linkGETlist_bookmarksList bookmarks (user-specific bookmarks of NetBox objects)GETget_bookmarkGet a specific bookmarkPOSTcreate_bookmarkCreate a bookmarkDELETEdelete_bookmarkDelete a bookmarkGETlist_notificationsList notifications (in-app messages for users, NetBox 4.1+)GETget_notificationGet a specific notificationPOSTcreate_notificationCreate a notification (typically used by automation, not humans)PATCHupdate_notificationMark notification as read by setting 'read' to a datetimeDELETEdelete_notificationDelete a notificationGETlist_notification_groupsList notification groups (sets of users + groups that receive event-rule notifications)GETget_notification_groupGet a specific notification groupPOSTcreate_notification_groupCreate a notification groupPATCHupdate_notification_groupUpdate a notification groupDELETEdelete_notification_groupDelete a notification groupGETlist_subscriptionsList subscriptions (per-user follow lists for specific objects)GETget_subscriptionGet a specific subscriptionPOSTcreate_subscriptionSubscribe a user to events on an objectDELETEdelete_subscriptionDelete a subscriptionGETlist_image_attachmentsList image attachments (rack diagrams, photos, etc. attached to NetBox objects)GETget_image_attachmentGet a specific image attachmentPOSTcreate_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 attachmentGETget_dashboardGet the current user's dashboard configuration (singleton -- not a list endpoint)PATCHupdate_dashboardUpdate the current user's dashboard layoutGETlist_usersList NetBox users. Admin-only endpoint.GETget_userGet a specific userPOSTcreate_userCreate a NetBox userPATCHupdate_userUpdate a user. Passing 'password' resets the password.DELETEdelete_userDelete a userGETlist_groupsList user groupsGETget_groupGet a specific groupPOSTcreate_groupCreate a user groupPATCHupdate_groupUpdate a groupDELETEdelete_groupDelete a groupGETlist_permissionsList object permissions (per-model + per-action grants assigned to users/groups)GETget_permissionGet a specific permissionPOSTcreate_permissionCreate an object permissionPATCHupdate_permissionUpdate a permissionDELETEdelete_permissionDelete a permissionGETlist_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 tokenPOSTprovision_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 sourcePOSTcreate_data_sourceCreate a data sourcePATCHupdate_data_sourceUpdate a data sourceDELETEdelete_data_sourceDelete a data sourcePOSTsync_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 typeGETlist_background_queuesList RQ background queues with statisticsGETlist_background_workersList active background workersGETlist_background_tasksList background tasks (RQ jobs)