NetBox icon

NetBox

Consume NetBox API

Actions243

Platform → Get

AI-generated

Overview

This node interacts with the NetBox API to retrieve information about a specific platform within the DCIM domain. It is useful for scenarios where you need to fetch detailed data about a platform by its ID, such as in network infrastructure management or asset tracking.

Use Case Examples

  1. Retrieve platform details by providing the platform ID in the DCIM domain.
  2. Use the node to get platform information for inventory or reporting purposes.

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.
Platform ID The unique identifier of the platform to retrieve from the NetBox API.

Output

JSON

  • id - The unique identifier of the platform.
  • name - The name of the platform.
  • slug - A URL-friendly identifier for the platform.
  • manufacturer - Details about the manufacturer of the platform.
  • napalm_driver - The NAPALM driver associated with the platform.
  • description - Description of the platform.
  • device_type_count - Number of device types associated with the platform.
  • created - Timestamp when the platform was created.
  • last_updated - Timestamp when the platform was last updated.

Dependencies

  • NetBox API
  • An API key credential for authentication

Troubleshooting

  • Ensure the Platform ID is correct and exists in the NetBox instance to avoid 'not found' errors.
  • Verify that the API key credential has sufficient permissions to access platform data.
  • Check network connectivity to the NetBox API endpoint.
  • Common error messages include authentication failures, invalid ID errors, and network timeouts. Resolving these involves verifying credentials, input values, and network status.

Links

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

Discussion