NetBox icon

NetBox

Consume NetBox API
Join our community

Actions88

Overview

This node interacts with the NetBox API, a popular infrastructure resource modeling tool. Specifically, for the Device resource and Delete operation, it deletes a device record identified by its ID within the selected domain of the NetBox API.

Typical use cases include:

  • Automating cleanup of device records in NetBox when devices are decommissioned.
  • Integrating with other systems to synchronize device lifecycle events by removing devices from NetBox automatically.
  • Managing large inventories where manual deletion would be inefficient.

Example: Automatically delete a device from the "DCIM" domain in NetBox by providing its unique device ID.

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. Default is DCIM.
Device ID The unique identifier (ID) of the device record to delete. Required when Domain is DCIM and Resource is Device with Delete operation.

Note: The property "Device ID" is shown only when Domain is "dcim", Resource is "devices", and Operation is "delete".

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be an empty response or confirmation that the device was deleted successfully. If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is involved.

Dependencies

  • Requires connection to a NetBox instance via its REST API.
  • Requires an API authentication token credential configured in n8n to authorize requests to NetBox.
  • The node depends on internal helper functions (from ./helpers/executeOperation) to perform the actual API call.

Troubleshooting

  • Common issues:

    • Invalid or missing device ID: The node requires a valid device ID to delete; ensure the ID exists in NetBox.
    • Authentication errors: Ensure the API key credential is correctly set up and has permissions to delete devices.
    • Network connectivity: Verify that n8n can reach the NetBox API endpoint.

  • Error messages:

    • Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output JSON under the error key.
    • Common error messages may include HTTP 404 (device not found), 401 (unauthorized), or 400 (bad request). Check the device ID and credentials accordingly.

Links and References

Discussion