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 retrieve information about a Device Bay within the DCIM domain. The "Get" operation fetches details of a single device bay by its unique identifier.
Typical use cases include:
- Automating infrastructure management workflows by retrieving device bay details for inventory or auditing.
- Integrating NetBox data into other systems or dashboards.
- Triggering conditional logic in workflows based on device bay attributes.
For example, you might use this node to get the status and configuration of a specific device bay before provisioning new hardware or updating documentation.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. For this operation, it must be DCIM. |
| Device Bay ID | The unique numeric identifier of the device bay record to retrieve from NetBox. |
Output
The node outputs a JSON object representing the device bay record retrieved from NetBox. This includes all standard fields provided by the NetBox API for a device bay, such as identifiers, names, status, associated devices, and other metadata.
No binary data output is produced by this operation.
Example output structure (simplified):
{
"id": 123,
"name": "Bay 1",
"device": { /* device details */ },
"status": "active",
"description": "Main device bay",
...
}
Dependencies
- Requires an active connection to a NetBox instance via an API key credential configured in n8n.
- The node depends on the NetBox API being accessible and the user having permission to read device bay records.
- No additional external dependencies beyond the NetBox API and proper authentication.
Troubleshooting
Common issues:
- Invalid or missing Device Bay ID will cause the API call to fail.
- Network connectivity problems to the NetBox server.
- Insufficient permissions or invalid API credentials.
Error messages:
- Errors returned from the NetBox API (e.g., 404 Not Found if the device bay ID does not exist).
- Authentication errors if the API key is invalid or expired.
Resolutions:
- Verify the Device Bay ID is correct and exists in NetBox.
- Check network connectivity and endpoint URL.
- Ensure the API key credential is valid and has appropriate permissions.
- Enable "Continue on Fail" in the node settings to handle errors gracefully in workflows.