NetBox icon

NetBox

Consume NetBox API

Actions243

Site Group → Delete

AI-generated

Overview

This node interacts with the NetBox API to delete a Site Group resource within the specified domain. It is useful for automating the removal of site group records in NetBox, which helps maintain an up-to-date inventory of site groupings in network infrastructure management.

Use Case Examples

  1. Deleting a site group by specifying its ID in the DCIM domain to clean up obsolete or incorrect site group entries.
  2. Automating the deletion of site groups 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. This determines the API endpoint domain for the operation.
ID The unique identifier of the Site Group record to delete within the specified domain.

Output

JSON

  • success - Indicates whether the deletion operation was successful.
  • message - Optional message providing additional information about the deletion result.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the provided ID corresponds to an existing Site Group in the specified domain; otherwise, the deletion will fail.
  • Verify that the API key credential has sufficient permissions to delete Site Group resources.
  • Common error messages may include authorization errors, resource not found, or network connectivity issues. Resolving these involves checking credentials, resource existence, and network access.

Links

Discussion