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
This node integrates with the NetBox API, specifically allowing users to interact with various domains and resources within NetBox. For the "Module Type" resource under the "DCIM" domain, the "List" operation fetches a list of module types from NetBox. This is useful for network engineers or IT asset managers who want to retrieve detailed information about hardware module types managed in their NetBox instance.
Practical examples include:
- Retrieving all module types available in your data center inventory.
- Filtering module types by manufacturer or model to audit hardware compatibility.
- Automating asset management workflows by syncing module type data with other systems.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to target. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. Default is DCIM. |
| Return All | Boolean flag indicating whether to return all results or limit the number of returned items. |
| Limit | Maximum number of results to return when "Return All" is false. Minimum value is 1. |
| Filters | Collection of filters to narrow down the list of module types: |
| - Module Type ID | Filter by specific module type ID (number). |
| - Model | Filter by model name (string). |
| - Manufacturer ID | Filter by manufacturer ID (number). |
| - Part Number | Filter by part number (string). |
Output
The node outputs JSON data representing the list of module types retrieved from the NetBox API. Each item in the output array corresponds to a module type object containing details such as ID, model, manufacturer, and part number, depending on the API response structure.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to a NetBox instance via its REST API.
- Requires an API authentication token credential configured in n8n to authorize requests.
- No additional external dependencies beyond the NetBox API and the provided credentials.
Troubleshooting
Common Issues:
- Authentication failures due to invalid or missing API tokens.
- Network connectivity issues preventing access to the NetBox server.
- Incorrect filter values leading to empty result sets.
- Exceeding API rate limits if requesting too many records without pagination.
Error Messages:
- Errors during execution are logged and, if "Continue On Fail" is enabled, returned as error messages in the output JSON.
- Typical errors include HTTP 401 Unauthorized (check API token), HTTP 404 Not Found (verify domain/resource correctness), and HTTP 429 Too Many Requests (rate limiting).
Resolutions:
- Verify and update the API authentication token.
- Confirm the NetBox URL and network accessibility.
- Adjust filters or increase the limit/enable "Return All" carefully.
- Implement retry logic or reduce request frequency if rate limited.