NetBox icon

NetBox

Consume NetBox API

Overview

This node integrates with the NetBox API, a popular infrastructure resource modeling tool. Specifically, the "Module Bay" resource's "Delete" operation allows users to remove a module bay record from their NetBox instance. This is useful for automating infrastructure cleanup tasks, such as removing obsolete or decommissioned hardware bays in data centers.

Practical examples include:

  • Automatically deleting a module bay when a device is retired.
  • Cleaning up test or temporary module bays created during automated provisioning workflows.
  • Integrating with change management systems to reflect physical changes in network hardware.

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. For this operation, must be "DCIM".
Module Bay ID The numeric ID of the module bay to delete. Required to identify which module bay record to remove.

Output

The node outputs a JSON object representing the result of the delete operation. Typically, for a successful deletion, the output may be an empty object or confirmation message depending on the NetBox API response. If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to a NetBox instance via its REST API.
  • 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 HTTP request to NetBox.

Troubleshooting

  • Common issues:

    • Invalid or missing Module Bay ID will cause the API to reject the request.
    • Insufficient permissions or invalid API token will result in authorization errors.
    • Network connectivity problems to the NetBox server can cause timeouts or connection failures.
  • Error messages and resolutions:

    • "404 Not Found": The specified Module Bay ID does not exist. Verify the ID is correct.
    • "401 Unauthorized" or "403 Forbidden": Check that the API token is valid and has sufficient permissions.
    • "400 Bad Request": Ensure all required parameters are correctly provided and formatted.
    • If the node returns an error but "Continue on Fail" is enabled, the error message will be included in the output JSON under the error key.

Links and References

Discussion