NetBox icon

NetBox

Consume NetBox API

Actions243

Device → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a device record within the specified domain. It is useful in scenarios where you need to programmatically remove device entries from NetBox, such as during automated cleanup processes or device lifecycle management.

Use Case Examples

  1. Deleting a device from the DCIM domain by specifying its device ID.
  2. Automating device removal in network infrastructure management workflows.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc.
Device ID The unique identifier of the device to be deleted within the DCIM domain.

Output

JSON

  • json - The JSON output contains the result of the delete operation, typically confirmation of deletion or error details if the operation fails.

Dependencies

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

Troubleshooting

  • Common issues include providing an invalid or non-existent Device ID, which will result in an error from the NetBox API indicating the device could not be found.
  • Authentication errors due to missing or incorrect API credentials will prevent the node from successfully deleting the device.
  • Network connectivity issues to the NetBox server can cause timeouts or failures in the delete operation.

Discussion