NetBox icon

NetBox

Consume NetBox API

Overview

This node interacts with the NetBox API, specifically allowing users to delete a Device Type resource within the DCIM domain. It is useful in scenarios where you need to programmatically remove device type records from your NetBox inventory, such as cleaning up obsolete or incorrect device types.

Practical examples include:

  • Automating cleanup of device types that are no longer used.
  • Integrating with other systems to synchronize device type data by removing outdated entries.
  • Managing device types in bulk through workflows.

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".
Device Type ID The unique identifier (ID) of the device type record to delete within the DCIM domain.

Output

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

No binary data is produced by this node.

Example output on error:

{
  "error": "Error message describing what went wrong"
}

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing Device Type ID will cause the delete operation to fail.
    • Incorrect domain selection (must be "dcim" for Device Type) will prevent the operation.
    • Network connectivity or authentication errors with the NetBox API.
  • Error messages:

    • "404 Not Found": The specified Device Type ID does not exist.
    • "401 Unauthorized" or "403 Forbidden": Authentication failure; check API credentials.
    • Other HTTP errors indicate issues with the request or server.
  • Resolution:

    • Verify the Device Type ID is correct and exists in NetBox.
    • Ensure the domain is set to "DCIM".
    • Confirm API credentials are valid and have sufficient permissions.
    • Check network connectivity to the NetBox server.

Links and References

Discussion