NetBox icon

NetBox

Consume NetBox API

Actions243

Interface Template → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete an Interface Template resource within the specified domain. It is useful for automating the removal of interface templates in network infrastructure management, particularly when cleaning up or decommissioning templates that are no longer needed.

Use Case Examples

  1. Deleting an interface template by specifying its ID in the DCIM domain to maintain an up-to-date network configuration.
  2. Automating the cleanup of obsolete interface templates in bulk operations.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc.
Interface Template ID The unique identifier of the interface template to delete within the DCIM domain.

Output

JSON

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

Dependencies

  • Requires an API key credential for authenticating with the NetBox API.

Troubleshooting

  • Ensure the Interface Template ID is correct and exists in the specified domain; otherwise, the deletion will fail.
  • Check API credentials and permissions to confirm the node has rights to delete resources.
  • Common error messages include 'Resource not found' if the ID does not exist, or 'Unauthorized' if API credentials are invalid or lack delete permissions.

Discussion