NetBox icon

NetBox

Consume NetBox API

Actions243

Location → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific Location resource within the DCIM domain. It is useful for scenarios where you need to fetch detailed data about a particular location in your data center infrastructure management system, such as for inventory tracking, auditing, or integration with other systems.

Use Case Examples

  1. Retrieve details of a data center location by its ID to display or process in an automation workflow.
  2. Fetch location information to verify or update related device placements or configurations.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Location ID The unique identifier of the location to retrieve from the NetBox API.

Output

JSON

  • id - The unique identifier of the location record.
  • name - The name of the location.
  • description - Description or details about the location.
  • status - Current status of the location.
  • custom_fields - Any custom fields associated with the location.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Location ID provided is valid and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API credentials have sufficient permissions to access the Location resource.
  • Check network connectivity to the NetBox API endpoint if requests fail or time out.

Links

Discussion