NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item Template → List

AI-generated

Overview

This node interacts with the NetBox API to list Inventory Item Templates within the DCIM domain. It is useful for users who want to retrieve and manage inventory item templates from their NetBox instance, enabling automation and integration of inventory data into workflows. For example, it can be used to fetch all inventory item templates or filter them based on specific criteria such as device type ID, name, label, or manufacturer ID.

Use Case Examples

  1. Retrieve all inventory item templates without limit.
  2. Fetch up to 50 inventory item templates filtered by a specific device type ID.
  3. Search inventory item templates by name or label.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to interact with, here it is set to 'dcim' for data center infrastructure management.
Return All Determines whether to return all results or limit the number of results returned.
Limit Maximum number of results to return when 'Return All' is false.
Filters Collection of filters to narrow down the list of inventory item templates, including search query, device type ID, name, label, role ID, manufacturer ID, part ID, ID, and ordering.

Output

JSON

  • id - Unique identifier of the inventory item template.
  • name - Name of the inventory item template.
  • label - Label associated with the inventory item template.
  • device_type_id - ID of the device type associated with the inventory item template.
  • role_id - Role ID related to the inventory item template.
  • manufacturer_id - Manufacturer ID of the inventory item template.
  • part_id - Part ID of the inventory item template.
  • ordering - Field used to order the results.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Common issues include incorrect API credentials, network connectivity problems, or invalid filter parameters.
  • Error messages may indicate authentication failures, invalid resource or operation names, or exceeding API rate limits.
  • To resolve errors, verify API credentials, check network access, and ensure filter parameters are correctly formatted.

Links

  • NetBox API Documentation - Official documentation for the NetBox API, useful for understanding available endpoints and parameters.

Discussion