Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
The "NetBox" node integrates with the NetBox API, a popular infrastructure resource modeling tool used for managing IP addresses, devices, racks, and other network resources. Specifically, the "Get Devices" operation under the "Site" resource allows users to retrieve device information associated with a particular site in NetBox.
This node is beneficial in scenarios where network engineers or IT administrators want to automate the retrieval of device inventories from specific sites within their infrastructure. For example, it can be used to fetch all devices installed at a data center site to audit hardware or integrate with other systems for monitoring or asset management.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. Options include: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, "DCIM" is used. |
| Site ID | The unique identifier of the site in NetBox from which to retrieve devices. |
| Return All | Boolean flag indicating whether to return all devices or limit the number of results. |
| Limit | Maximum number of device results to return if "Return All" is false. |
Output
The node outputs JSON data representing the list of devices retrieved from the specified site. Each item in the output array corresponds to a device object as returned by the NetBox API, containing details such as device name, type, status, and other metadata.
If the node encounters an error during execution and "Continue on Fail" is enabled, it outputs a JSON object with an error field describing the issue.
The node does not output binary data.
Dependencies
- Requires access to a NetBox instance with its API enabled.
- Requires an API authentication token or key credential configured in n8n to authenticate requests to the NetBox API.
- No additional external dependencies are indicated.
Troubleshooting
Common Issues:
- Invalid or missing Site ID will result in errors or empty results.
- Insufficient API permissions or invalid API credentials may cause authentication failures.
- Network connectivity issues to the NetBox server can prevent successful API calls.
Error Messages:
- Errors thrown by the node will be logged in the console.
- If "Continue on Fail" is enabled, errors are returned as part of the node's output JSON under the
errorproperty. - To resolve errors, verify the Site ID, ensure valid API credentials, and confirm network accessibility to the NetBox API endpoint.