NetBox icon

NetBox

Consume NetBox API

Actions243

Interface → Get Connections

AI-generated

Overview

This node interacts with the NetBox API to retrieve connection information for a specific network interface within the DCIM domain. It is useful for network administrators or automation workflows that need to fetch details about how a particular interface is connected to other devices or interfaces in the network infrastructure. For example, it can be used to automate network documentation or to verify interface connectivity programmatically.

Use Case Examples

  1. Retrieve all connections for a given interface ID to audit network topology.
  2. Fetch interface connection details to integrate with a network monitoring system.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to target, such as DCIM, IPAM, Tenancy, etc. For this operation, it is set to 'dcim'.
Interface ID The unique identifier of the interface for which to get connection information.

Output

JSON

  • json - The JSON response containing the connection details of the specified interface from the NetBox API.

Dependencies

  • NetBox API with appropriate credentials

Troubleshooting

  • Ensure the Interface ID is valid and exists in the NetBox instance; otherwise, the API call will fail.
  • Verify that the API credentials have sufficient permissions to access interface connection data.
  • If the node throws an error, check network connectivity to the NetBox server and API endpoint availability.
  • Enable 'Continue on Fail' option to handle errors gracefully and receive error messages as output instead of stopping execution.

Links

Discussion