NetBox icon

NetBox

Consume NetBox API

Actions243

Inventory Item → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve details of a specific Inventory Item within the DCIM domain. It is useful for scenarios where you need to fetch detailed information about an inventory item by its ID, such as in asset management, inventory tracking, or integration workflows that require up-to-date inventory data from NetBox.

Use Case Examples

  1. Retrieve an inventory item by its ID to display its details in a dashboard.
  2. Fetch inventory item information to synchronize with another asset management system.

Properties

Name Meaning
Domain Specifies the domain of the NetBox API to use, here it is set to 'dcim' for data center infrastructure management.
Inventory Item ID The unique identifier of the inventory item to retrieve from the NetBox API.

Output

JSON

  • id - The unique identifier of the retrieved inventory item.
  • name - The name of the inventory item.
  • description - Description or details about the inventory item.
  • device - The device to which the inventory item is associated.
  • manufacturer - Manufacturer information of the inventory item.
  • serial - Serial number of the inventory item.
  • asset_tag - Asset tag associated with the inventory item.
  • created - Timestamp when the inventory item was created.
  • last_updated - Timestamp of the last update to the inventory item.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Inventory Item ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to read inventory items.
  • Check network connectivity to the NetBox API endpoint.
  • If the node throws an error, enabling 'Continue on Fail' allows the workflow to handle errors gracefully by returning the error message as output.

Links

Discussion