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, a popular infrastructure resource modeling tool. Specifically, for the Interface resource and the Delete operation, it allows users to delete a network interface record from NetBox by specifying its unique identifier.
Common scenarios where this node is beneficial include:
- Automating cleanup of obsolete or decommissioned network interfaces in your infrastructure.
- Integrating with workflows that manage device lifecycle, ensuring interfaces are removed when devices are retired.
- Synchronizing NetBox data with other systems by programmatically deleting interfaces no longer present or needed.
Example: Automatically delete an interface from NetBox after a device is removed from your inventory system.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to target. Options include: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For Interface resource, domain must be "dcim". |
| Interface ID | The unique identifier (ID) of the interface record to delete within the DCIM domain. |
Output
The node outputs JSON data representing the result of the delete operation. Typically, this will be confirmation of deletion or an empty response indicating success. If an error occurs, the output JSON will contain an error field with the error message.
No binary data output is produced by this node.
Dependencies
- Requires connection to a NetBox instance via its REST API.
- Needs an API authentication token credential configured in n8n to authorize requests to NetBox.
- The node depends on an internal helper function (
executeOperation) to perform the actual API call.
Troubleshooting
Common issues:
- Providing an invalid or non-existent Interface ID will cause the deletion to fail.
- Incorrect domain or resource selection may lead to errors or unexpected behavior.
- Missing or invalid API credentials will prevent successful communication with NetBox.
Error messages:
- Errors returned from the NetBox API (e.g., 404 Not Found if the interface does not exist).
- Network or authentication errors if the API endpoint is unreachable or credentials are invalid.
Resolutions:
- Verify the Interface ID exists in NetBox before attempting deletion.
- Ensure the domain is set to "dcim" when working with interfaces.
- Confirm API credentials are correctly configured and have sufficient permissions.