NetBox icon

NetBox

Consume NetBox API

Overview

This node interacts with the NetBox API, specifically allowing users to retrieve information about device types within the "DCIM" domain of NetBox. It is useful for network engineers and IT professionals who want to programmatically access detailed metadata about hardware device types managed in their NetBox instance. For example, you can use this node to fetch details about a specific device type by its ID, which can then be used for inventory management, automation workflows, or integration 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 should be set to DCIM.
Device Type ID The unique identifier (ID) of the device type record you want to retrieve from NetBox. This is a required string input.

Output

The node outputs JSON data representing the device type object retrieved from the NetBox API. This JSON will contain all the fields and metadata associated with the specified device type, such as model name, manufacturer, part number, and other relevant attributes defined in NetBox.

The node does not output binary data.

Dependencies

  • Requires an active connection to a NetBox instance.
  • Requires an API key credential configured in n8n to authenticate requests to the NetBox API.
  • The node depends on internal helper functions to execute the API operation but no external npm packages beyond those bundled.

Troubleshooting

  • Common issues:

    • Invalid or missing Device Type ID: Ensure the ID provided corresponds to an existing device type in your NetBox instance.
    • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
    • Network connectivity problems: Confirm that the n8n server can reach the NetBox API endpoint.
  • Error messages:

    • If the node throws an error related to the API call, the message will typically indicate the HTTP error or authentication failure.
    • When "Continue on Fail" is enabled, errors are returned as JSON output with an error field containing the message, allowing workflow continuation.

Links and References

Discussion