NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete an Inventory Item within the specified domain. It is useful for automating the removal of inventory items from NetBox, which is a popular infrastructure resource modeling tool. For example, it can be used in workflows that manage hardware lifecycle by automatically deleting inventory items when they are decommissioned.

Use Case Examples

  1. Deleting an inventory item by its ID in the DCIM domain to keep the inventory up to date.
  2. Automating cleanup of inventory items in NetBox as part of a larger infrastructure management process.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc. This determines the API endpoint domain for the operation.
Inventory Item ID The unique identifier of the inventory item to be deleted. This is required to specify which inventory item record to remove.

Output

JSON

  • success - Indicates whether the deletion operation was successful.
  • error - If an error occurs and 'continue on fail' is enabled, this field contains the error message.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include providing an invalid or non-existent Inventory Item ID, which will cause the deletion to fail.
  • If the API credentials are incorrect or lack permissions, the node will throw an authentication or authorization error.
  • Enabling 'continue on fail' will cause the node to output error details instead of stopping the workflow on failure.

Links

Discussion