NetBox icon

NetBox

Consume NetBox API

Actions243

Region → List

AI-generated

Overview

This node interacts with the NetBox API to list regions within the DCIM domain. It allows users to retrieve a list of regions with optional filtering and pagination controls. This is useful for network administrators or IT professionals who need to manage or audit geographical or logical regions defined in their NetBox instance.

Use Case Examples

  1. List all regions in the DCIM domain to get an overview of all defined regions.
  2. Retrieve a limited number of regions with specific filters such as region name or parent region to narrow down the 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 results or limit the number of results returned.
Limit Maximum number of region results to return when 'Return All' is false.
Filters Optional filters to narrow down the list of regions based on criteria such as region ID, name, slug, description, parent region ID or name, and tags.

Output

JSON

  • id - Unique identifier of the region.
  • name - Name of the region.
  • slug - Slug (URL-friendly identifier) of the region.
  • description - Description of the region.
  • parent_id - ID of the parent region if applicable.
  • parent - Name or slug of the parent region.
  • tag - Tags associated with the region.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Common issues include authentication errors due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Filtering parameters must be valid and correctly formatted; otherwise, the API may return errors or empty results.
  • If 'Return All' is false and the limit is set too low, the user might not see all expected results. Adjust the limit or enable 'Return All' as needed.

Links

Discussion