NetBox icon

NetBox

Consume NetBox API

Actions243

Power Outlet → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a specified Power Outlet resource within the selected domain. It is useful for automating the removal of power outlet records from NetBox, which is a network infrastructure management tool. For example, it can be used in workflows that manage data center equipment lifecycle by removing obsolete or decommissioned power outlets.

Use Case Examples

  1. Deleting a power outlet by specifying its ID in the DCIM domain to keep the NetBox inventory up to date.
  2. Automating cleanup of power outlet records when devices are removed from the infrastructure.

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.
Power Outlet ID The unique identifier of the power outlet to be deleted. Required to specify which power outlet record to remove.

Output

JSON

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

Dependencies

  • NetBox API
  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Ensure the Power Outlet ID is correct and exists in the specified domain; otherwise, the deletion will fail.
  • Verify that the API key credential has sufficient permissions to delete power outlet resources in NetBox.
  • Common error messages include authorization errors (due to invalid or insufficient credentials) and not found errors (if the specified power outlet ID does not exist). Resolving these involves checking credentials and verifying the ID.

Links

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

Discussion