NetBox icon

NetBox

Consume NetBox API

Overview

This node integrates with the NetBox API, specifically allowing users to update a Manufacturer record within the "DCIM" domain. It is useful for network engineers and IT asset managers who want to programmatically modify manufacturer details in their NetBox inventory system. For example, you can update the name, slug, description, tags, or custom fields of a manufacturer entity to keep your asset database accurate and up-to-date.

Properties

Name Meaning
Domain The domain of the NetBox API to interact with. Options include: DCIM, IPAM, Tenancy, etc.
Manufacturer ID The unique identifier of the manufacturer to update.
Update Fields A collection of fields to update on the manufacturer:
- Name New name of the manufacturer.
- Slug URL-friendly slug for the manufacturer.
- Description Text description of the manufacturer.
- Tags Comma-separated list of tags associated with the manufacturer.
- Custom Fields JSON object containing any custom fields to update for the manufacturer.

Output

The node outputs a JSON object representing the updated manufacturer record as returned by the NetBox API. This typically includes all standard manufacturer properties reflecting the new state after the update operation.

If an error occurs and "Continue on Fail" is enabled, the output will contain a JSON object with an error field describing the issue.

No binary data output is produced by this node.

Dependencies

  • Requires connection to a NetBox instance via its REST API.
  • Requires an API authentication token credential configured in n8n to authorize requests.
  • The node depends on internal helper functions (e.g., executeOperation) to perform the HTTP request to NetBox.

Troubleshooting

  • Common Issues:

    • Invalid or missing Manufacturer ID will cause the update to fail.
    • Incorrect API credentials or insufficient permissions may result in authorization errors.
    • Providing malformed JSON in custom fields can cause request rejection.
  • Error Messages:

    • Errors from the NetBox API are caught and logged. If "Continue on Fail" is disabled, the node execution stops with the error.
    • When "Continue on Fail" is enabled, errors are returned as part of the output JSON under the error key.
  • Resolution Tips:

    • Verify the Manufacturer ID exists in NetBox before updating.
    • Ensure the API token has write permissions for the DCIM domain.
    • Validate JSON syntax for custom fields before submitting.

Links and References

Discussion