NetBox icon

NetBox

Consume NetBox API

Overview

This node integrates with the NetBox API, a popular infrastructure resource modeling tool used for managing IP addresses, devices, and other network resources. Specifically, the "Module Type" resource's "Create" operation allows users to add new module types within the DCIM domain of NetBox.

Typical use cases include automating the addition of hardware module types (e.g., transceivers, line cards) into NetBox as part of network inventory management or provisioning workflows. For example, when onboarding new hardware models from a manufacturer, this node can programmatically create corresponding module type entries in NetBox, ensuring consistent and up-to-date device metadata.

Properties

Name Meaning
Domain The NetBox API domain to target. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, must be DCIM.
Model The model name of the module type to create.
Manufacturer ID Numeric ID of the manufacturer associated with the module type.
Additional Fields Optional extra fields for the module type:
- Part Number Part number identifier for the module type.
- Weight Weight value of the module type.
- Weight Unit Unit of weight measurement. Options: Kilograms (kg), Grams (g), Pounds (lb), Ounces (oz).
- Description Text description of the module type.
- Comments Additional comments about the module type.
- Tags Comma-separated list of tag IDs to associate with the module type.
- Custom Fields JSON string representing custom fields for the module type.

Output

The node outputs the response from the NetBox API after creating the module type. This output is structured as JSON containing the details of the newly created module type object, including its assigned ID and all provided properties.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to a NetBox instance via its REST API.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • The node relies on internal helper functions to execute the API operation but does not require additional external libraries beyond those bundled.

Troubleshooting

  • Common Issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect manufacturer ID or model name may result in API validation errors.
    • Improperly formatted JSON in custom fields can cause request rejection.
  • Error Messages:
    • Authentication errors typically indicate invalid or expired API tokens; verify and update credentials.
    • Validation errors from NetBox will specify which fields are incorrect; review input values accordingly.
    • Network connectivity issues will manifest as request timeouts or unreachable host errors; check network access to the NetBox server.

Links and References

Discussion