Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Region → Get Sites
AI-generatedOverview
This node interacts with the NetBox API to retrieve sites associated with a specific region within the DCIM domain. It is useful for network administrators or IT professionals who need to programmatically access site information grouped by region in their NetBox instance. For example, it can be used to fetch all sites under a given region ID, either returning all results or limiting the number of results for performance or pagination purposes.
Use Case Examples
- Retrieve all sites for a region to display in a network management dashboard.
- Fetch a limited number of sites for a region to process in a workflow that updates site details.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management. |
| Region ID | The unique identifier of the region for which to retrieve associated sites. |
| Return All | Boolean flag indicating whether to return all site results or limit the number of results. |
| Limit | Maximum number of site results to return if 'Return All' is false. |
Output
JSON
sites- Array of site objects associated with the specified region.
Dependencies
- NetBox API with appropriate credentials
Troubleshooting
- Ensure the Region ID is valid and exists in the NetBox instance to avoid errors.
- If the API credentials are incorrect or missing, authentication errors will occur.
- If 'Return All' is false and 'Limit' is set too low, not all sites will be retrieved, which might cause incomplete data issues.
Links
- NetBox API Documentation - Regions - Official documentation for the Regions resource in the NetBox DCIM API, including how to get sites for a region.