NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item Template → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete an Inventory Item Template within the specified domain. It is useful for automating the removal of inventory item templates in network infrastructure management, ensuring that outdated or unnecessary templates are programmatically cleaned up.

Use Case Examples

  1. Deleting an Inventory Item Template by specifying its ID in the DCIM domain to maintain an up-to-date inventory system.
  2. Automating cleanup of inventory templates in bulk operations by integrating this node in workflows.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc. This determines the API segment to interact with.
Inventory Item Template ID The unique identifier of the inventory item template to delete. Required when the domain is DCIM and the resource is inventory-item-templates.

Output

JSON

  • success - Indicates whether the deletion was successful.
  • message - Provides additional information or error message related to the deletion operation.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Inventory Item Template ID is correct and exists in the specified domain; otherwise, the deletion will fail.
  • Verify that the API credentials have sufficient permissions to delete inventory item templates.
  • Common error messages may include authorization errors, resource not found, or network connectivity issues. Check the error message returned in the output for guidance.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and required parameters.

Discussion