Overview

This node interacts with the NetBox API to retrieve information about a specific Region resource within the DCIM domain. It is useful for scenarios where users need to fetch detailed data about a particular region by its ID, such as in network infrastructure management or data center organization.

Use Case Examples

1. Retrieve details of a region by providing its Region ID in the DCIM domain of NetBox API.
2. Use the node to get region information for reporting or automation workflows in network management.

Properties

Output

JSON

• id - The unique identifier of the region.
• name - The name of the region.
• slug - The slug (URL-friendly identifier) of the region.
• description - Description of the region.
• parent - Parent region if applicable.
• site_count - Number of sites within the region.

Dependencies

• NetBox API with appropriate credentials

Troubleshooting

• Ensure the Region ID provided is correct and exists in the NetBox instance.
• Verify that the API credentials are valid and have sufficient permissions to access the Region resource.
• Check network connectivity to the NetBox API endpoint.
• If the node throws an error, enabling 'Continue on Fail' will allow the workflow to proceed and output the error message for debugging.

Links

• NetBox API Documentation - Regions - Official documentation for the Region resource in the NetBox DCIM API.