NetBox icon

NetBox

Consume NetBox API

Actions243

Site → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a site record within the DCIM domain. It is useful for automating the removal of site entries in NetBox, which is a popular infrastructure resource modeling tool. For example, if a site is decommissioned or no longer needed, this node can be used to programmatically delete the site by specifying its Site ID.

Use Case Examples

  1. Deleting a site from the DCIM domain by providing the Site ID to remove obsolete or incorrect site data.
  2. Automating cleanup of site records in NetBox as part of infrastructure lifecycle management.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Site ID The unique identifier of the site to be deleted in the DCIM domain.

Output

JSON

  • success - Indicates whether the site deletion was successful.
  • message - Provides additional information or confirmation about the deletion operation.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Site ID provided is correct and exists in the NetBox instance; otherwise, the deletion will fail.
  • Verify that the API credentials have sufficient permissions to delete site records in the DCIM domain.
  • Common error messages may include authorization errors or resource not found errors, which indicate permission issues or invalid Site ID respectively.

Links

Discussion