NetBox icon

NetBox

Consume NetBox API

Actions243

Site Group → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Site Group within the DCIM domain. It is useful for scenarios where you need to fetch detailed data about a particular site group by its ID, such as in network infrastructure management or asset tracking.

Use Case Examples

  1. Retrieve details of a site group by providing its unique ID to monitor or update network site configurations.
  2. Fetch site group information to integrate with other systems or dashboards for network management.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
ID The unique identifier of the Site Group record to retrieve.

Output

JSON

  • id - The unique identifier of the Site Group.
  • name - The name of the Site Group.
  • slug - A URL-friendly identifier for the Site Group.
  • parent - Reference to the parent Site Group if any.
  • description - Description of the Site Group.
  • custom_fields - Any custom fields associated with the Site Group.
  • tags - Tags assigned to the Site Group.

Dependencies

  • NetBox API with appropriate authentication credentials

Troubleshooting

  • Ensure the Site Group ID provided is correct and exists in the NetBox instance.
  • Verify that the API credentials have sufficient permissions to access Site Group data.
  • Check network connectivity to the NetBox API endpoint.
  • Common error messages include authentication failures, resource not found (404), and permission denied (403). Resolving these involves verifying credentials, IDs, and user permissions.

Links

Discussion