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
Site Group → Get Many
AI-generatedOverview
This node interacts with the NetBox API to retrieve multiple site group records within the DCIM domain. It is useful for scenarios where users need to fetch a list of site groups, optionally applying filters, limiting the number of results, or retrieving all available records. For example, it can be used to gather site group data for inventory management or network infrastructure documentation.
Use Case Examples
- Fetch all site groups without limit to get a complete list.
- Retrieve up to 50 site groups with specific filters such as name or parent ID to narrow down results.
Properties
| Name | Meaning |
|---|---|
| Domain | Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management. |
| Return All | Determines whether to return all site group records or limit the number of results. |
| Limit | Maximum number of site group records to return when 'Return All' is false. |
| Filters | Optional filters to refine the list of site groups returned, such as filtering by name, slug, parent ID, search query, ID, ordering, creation date, or last updated date. |
Output
JSON
id- Unique identifier of the site group.name- Name of the site group.slug- Slug identifier of the site group.parent_id- Identifier of the parent site group, if any.created- Creation timestamp of the site group.last_updated- Timestamp of the last update to the site group.
Dependencies
- NetBox API
- API key credential for authentication
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
- Incorrect domain or resource selection may lead to no data returned or errors. Verify the domain is set to 'dcim' and resource to 'site-groups' for this operation.
- Filters with incorrect field names or invalid values may cause the API to return errors or empty results. Double-check filter names and values.
- If 'Return All' is false and limit is set too low, the returned data may be incomplete. Adjust the limit or enable 'Return All' as needed.
Links
- NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.