NetBox icon

NetBox

Consume NetBox API
Join our community

Actions88

Overview

This node interacts with the NetBox API to list device types within the DCIM domain. It allows users to retrieve a collection of device type records from their NetBox instance, optionally filtered and limited according to specified criteria. This is useful for network administrators or IT professionals who want to automate inventory management, audit hardware models, or integrate device type data into other workflows.

Practical examples include:

  • Fetching all device types to synchronize with an asset management system.
  • Filtering device types by manufacturer or model to generate reports.
  • Retrieving a limited number of device types for quick previews or dashboards.

Properties

Name Meaning
Domain The domain of the NetBox API to use. For this operation, it must be set to DCIM.
Return All Whether to return all matching device types or only up to a specified limit. If true, all results are returned; if false, the number of results is capped by the Limit property.
Limit Maximum number of device types to return when Return All is false. Must be at least 1.
Filters A collection of optional filters to narrow down the list of device types:
- Device Type ID Filter by exact device type ID (number).
- Model Filter by model name (case-insensitive string match).
- Slug Filter by slug identifier (string).
- Part Number Filter by part number (string).
- Manufacturer ID Filter by manufacturer ID (number).
- Manufacturer Filter by manufacturer name slug (string).
- Has Console Ports Filter device types that have one or more console ports (boolean).
- Has Console Server Ports Filter device types that have one or more console server ports (boolean).
- Has Power Ports Filter device types that have one or more power ports (boolean).
- Has Power Outlets Filter device types that have one or more power outlets (boolean).
- Has Interfaces Filter device types that have one or more interfaces (boolean).
- Has Pass-Through Ports Filter device types that have one or more pass-through ports (boolean).
- Has Device Bays Filter device types that have one or more device bays (boolean).
- Tag Filter by tag (string).
- Height (U) Filter by rack height in units (number).
- Is Full Depth Filter device types that consume both front and rear rack faces (boolean).
- Subdevice Role Filter by subdevice role, either "Parent" or "Child".

Output

The node outputs an array of JSON objects representing device types retrieved from the NetBox API. Each object corresponds to a device type and includes its properties as returned by the API, such as ID, model, manufacturer details, physical attributes, and any other metadata available in NetBox.

If binary data were involved (not applicable here), it would be summarized accordingly, but this operation deals solely with JSON data.

Dependencies

  • Requires access to a NetBox instance with the API enabled.
  • Requires an API authentication token or key configured in n8n credentials to authorize 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 with n8n.

Troubleshooting

  • Common issues:

    • Authentication failures due to invalid or missing API tokens.
    • Network connectivity problems preventing access to the NetBox API endpoint.
    • Incorrect domain or resource selections causing no data to be returned.
    • Using filters with incorrect data types or unsupported 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 output JSON with an error field containing the message.
    • To resolve errors, verify API credentials, ensure the NetBox instance is reachable, and confirm filter parameters are valid.

Links and References

Discussion