Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node interacts with the NetBox API, specifically targeting the "Region" resource to retrieve associated "Sites". It is designed to fetch site data linked to a particular region within the DCIM domain of NetBox. This functionality is useful in network and infrastructure management scenarios where users need to programmatically access site information grouped by regions for inventory, monitoring, or automation purposes.
For example, a user managing multiple data centers might use this node to list all sites within a specific geographic region to automate reporting or synchronize site data with other systems.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. Options include: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, it must be "DCIM". |
| Region ID | The unique identifier of the region from which to retrieve sites. |
| Return All | Whether to return all available results or limit the number of returned items. |
| Limit | The maximum number of site results to return if "Return All" is false. |
Output
The node outputs JSON data representing the list of sites associated with the specified region. Each item in the output corresponds to a site object as returned by the NetBox API under the DCIM domain. The structure typically includes site details such as name, slug, status, location, and other metadata defined by NetBox's site schema.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to a NetBox instance via its API.
- Needs an API authentication token or key configured in n8n credentials to authorize requests.
- The node depends on an internal helper function (
executeOperation) to perform the API call.
Troubleshooting
Common Issues:
- Invalid or missing Region ID will result in errors or empty responses.
- Incorrect domain selection (anything other than "dcim") will not work for this operation.
- API authentication failures due to invalid or expired credentials.
- Network connectivity issues to the NetBox server.
Error Messages:
- Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output JSON with an
errorfield containing the message. - Authentication errors typically indicate invalid credentials; verify API key/token setup.
- Not found or bad request errors suggest invalid Region ID or malformed parameters; double-check inputs.
- Errors thrown during execution are logged and, if "Continue on Fail" is enabled, returned as part of the output JSON with an