NetBox icon

NetBox

Consume NetBox API

Actions243

Interface → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete an interface resource within the specified domain. It is useful for automating the removal of network interface records in NetBox, which can help maintain accurate and up-to-date network infrastructure data. For example, it can be used to delete an interface by its ID in the DCIM domain.

Use Case Examples

  1. Deleting a network interface by its ID in the DCIM domain to clean up obsolete or unused interfaces.
  2. Automating interface deletions as part of a network decommissioning workflow.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc.
Interface ID The unique identifier of the interface to be deleted. Required when the domain is DCIM and the resource is interfaces.

Output

JSON

  • json - The JSON response from the NetBox API after attempting to delete the interface, typically indicating success or failure.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Interface ID provided is correct and exists in the specified domain and resource.
  • Verify that the API credentials have sufficient permissions to delete interface resources.
  • Common error messages may include authorization errors, resource not found, or invalid ID format. Resolving these involves checking credentials, verifying the interface ID, and ensuring the domain and resource are correctly set.

Discussion