NetBoxInstall

Overview

This node interacts with the NetBox API, a popular infrastructure resource modeling tool used for managing IP addresses, devices, and other network resources. Specifically, the "Module Bay Template" resource's "Delete" operation allows users to delete a module bay template record from the NetBox system.

Typical use cases include:

• Automating cleanup of obsolete or incorrect module bay templates in NetBox.
• Integrating NetBox management into broader automation workflows where module bay templates need to be programmatically removed.
• Maintaining synchronization between NetBox and external inventory systems by deleting templates that no longer exist externally.

Example: A network engineer wants to remove a deprecated module bay template identified by its ID from the DCIM domain in NetBox as part of an automated decommissioning process.

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.
Module Bay Template ID	The numeric ID of the module bay template to delete. Required when Domain is DCIM and Resource is Module Bay Template.

Note: For this specific operation (Delete on Module Bay Template), only the "Domain" set to "dcim" and the "Module Bay Template ID" are relevant.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be either:

• Confirmation of successful deletion (often an empty object or status message).
• An error object if the deletion failed, containing an error field with the error message.

No binary data output is expected for this operation.

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 sufficient permissions to delete module bay templates.
• No additional external dependencies beyond the NetBox API and the provided API authentication.

Troubleshooting

• Common issues:

  • Invalid or missing Module Bay Template ID: Ensure the ID corresponds to an existing template.
  • Insufficient permissions: The API token must have delete rights on the targeted resource.
  • Network connectivity problems: Verify the NetBox API URL and network access.
  • Incorrect Domain or Resource selection: Must be "dcim" domain and "module-bay-templates" resource for this operation.

• Error messages:

  • "404 Not Found": The specified Module Bay Template ID does not exist.
  • "401 Unauthorized" or "403 Forbidden": Authentication failure or insufficient permissions.
  • "400 Bad Request": Malformed request, possibly due to invalid parameters.

To resolve errors, verify input parameters, credentials, and API endpoint accessibility.

Links and References

• NetBox Official Documentation
• NetBox API Reference
• n8n Documentation