NetBox icon

NetBox

Consume NetBox API

Overview

This node integrates with the NetBox API, specifically allowing users to list manufacturers within the "DCIM" domain of NetBox. It is useful for retrieving a filtered or complete list of hardware manufacturers registered in a NetBox instance. Typical use cases include inventory management, automation workflows that require manufacturer data, or synchronizing manufacturer information with other systems.

For example, you might use this node to:

  • Fetch all manufacturers to populate a dropdown in another workflow.
  • Retrieve manufacturers matching specific criteria such as name or tag.
  • Limit the number of results returned for performance reasons.

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 must be "DCIM".
Return All Boolean flag indicating whether to return all manufacturer records or limit the number of results.
Limit Maximum number of manufacturer records to return if "Return All" is false. Minimum value is 1.
Filters Collection of optional filters to narrow down the list of manufacturers:
   Manufacturer ID Filter by exact manufacturer ID (number).
   Name Filter by manufacturer name (string).
   Slug Filter by manufacturer slug (string).
   Description Filter by description text (string).
   Tag Filter by tag (string).

Output

The node outputs JSON data representing the list of manufacturers retrieved from the NetBox API. Each item in the output array corresponds to a manufacturer object containing details such as ID, name, slug, description, and tags as provided by the NetBox API.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to a NetBox instance via an API key credential configured in n8n.
  • The node depends on the NetBox API being accessible and properly authenticated.
  • No additional external services are required beyond the NetBox API.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API credentials.
    • Network connectivity problems preventing access to the NetBox API.
    • Incorrect domain or resource selection causing no data to be returned.
    • Using filters with incorrect data types or values may result in empty responses.
  • Error messages:

    • Errors thrown during execution will be logged to the console.
    • If "Continue on Fail" is enabled, errors will be returned as part of the node's output JSON under an error field.
    • To resolve authentication errors, verify the API key credential configuration.
    • For network errors, check connectivity and endpoint URL correctness.
    • Ensure filter values match expected types and exist in the NetBox instance.

Links and References

Discussion