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 interacts with the NetBox API, specifically targeting the "Device Bay Template" resource within the "DCIM" domain. The "List" operation retrieves a collection of device bay templates from NetBox, optionally filtered by certain criteria or limited in number.
Use cases include:
- Fetching all or a subset of device bay templates to integrate with asset management workflows.
- Filtering device bay templates by ID, device type, or name to find specific templates for automation or reporting.
- Synchronizing device bay template data between NetBox and other systems.
For example, you might use this node to list all device bay templates associated with a particular device type to automate provisioning or inventory updates.
Properties
| Name | Meaning |
|---|---|
| Domain | The NetBox API domain to target. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, must be "DCIM". |
| Return All | Whether to return all results (true) or limit the number of results returned (false). |
| Limit | Maximum number of results to return when "Return All" is false. Minimum value is 1. |
| Filters | Optional filters to narrow down results: |
| Device Bay Template ID | Filter by specific device bay template ID (number). |
| Device Type ID | Filter by device type ID (number). |
| Name | Filter by device bay template name (string). |
Output
The node outputs an array of JSON objects representing device bay templates retrieved from NetBox. Each object corresponds to a device bay template and includes its properties as defined by the NetBox API.
If the node supports binary data output (not indicated here), it would typically represent file attachments or similar content related to the resource, but this operation focuses on JSON data only.
Dependencies
- Requires access to a NetBox instance with the API enabled.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The node depends on an internal helper function (
executeOperation) to perform the API call.
Troubleshooting
Common issues:
- Authentication failures due to missing or invalid API credentials.
- Network connectivity problems preventing access to the NetBox API.
- Incorrect filter values causing no results to be returned.
- Exceeding API rate limits if requesting too many records without pagination.
Error messages:
- Errors thrown during execution are logged and, if "Continue On Fail" is enabled, returned as part of the output JSON under an
errorfield. - Typical error messages may include HTTP errors (401 Unauthorized, 404 Not Found) or validation errors for filters.
- Errors thrown during execution are logged and, if "Continue On Fail" is enabled, returned as part of the output JSON under an
Resolutions:
- Verify API credentials and permissions.
- Check network connectivity and API endpoint URL.
- Adjust filters to valid values.
- Use "Return All" cautiously or apply limits to avoid large data requests.