Overview

This node interacts with the NetBox API to delete a specified Region resource within the selected domain. It is useful for automating the removal of region entries in NetBox, which is a popular infrastructure resource modeling tool. For example, a user can delete a region by providing its ID and the domain it belongs to, streamlining infrastructure management workflows.

Use Case Examples

1. Deleting a region from the DCIM domain by specifying the region ID to keep the NetBox data up to date.
2. Automating cleanup of obsolete regions in the tenancy domain by deleting regions via their IDs.

Properties

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 Region ID provided is correct and exists in the selected domain; otherwise, the deletion will fail.
• Verify that the API key credential has sufficient permissions to delete resources in the specified domain.
• Common error messages include authorization errors if the API key is invalid or lacks delete permissions, and not found errors if the Region ID does not exist.

Links

• NetBox API Documentation - Official documentation for the NetBox API, useful for understanding resource endpoints and operations.