NetBox icon

NetBox

Consume NetBox API

Actions243

Site → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Site resource. It is useful for scenarios where you need to fetch detailed data about a site within the NetBox infrastructure management system, such as its attributes or configuration details. For example, it can be used to get site details by providing the site ID within the DCIM domain.

Use Case Examples

  1. Retrieve site details by specifying the site ID in the DCIM domain to integrate site information into an automation workflow.
  2. Fetch site data to monitor or audit infrastructure locations managed in NetBox.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, e.g., DCIM, IPAM, Tenancy, etc.
Site ID The unique identifier of the site to retrieve within the DCIM domain.

Output

JSON

  • id - The unique identifier of the site.
  • name - The name of the site.
  • slug - The URL-friendly identifier of the site.
  • status - The operational status of the site.
  • region - The region to which the site belongs.
  • tenant - The tenant associated with the site.
  • facility - Facility information of the site.
  • asn - Autonomous System Number associated with the site.
  • physical_address - Physical address of the site.
  • shipping_address - Shipping address of the site.
  • contact_name - Contact person for the site.
  • contact_phone - Contact phone number for the site.
  • contact_email - Contact email for the site.
  • comments - Additional comments about the site.

Dependencies

  • An API key credential for authenticating with the NetBox API

Troubleshooting

  • Ensure the Site ID is correctly provided and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to access the Site resource in the DCIM domain.
  • If the node throws authentication errors, check the validity and scope of the API key used.

Links

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

Discussion