Actions243
- Cable Actions
- Cable Termination Actions
- Connected Device Actions
- Console Port Actions
- Console Port Template Actions
- Console Server Port Actions
- Console Server Port Template Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Front Port Actions
- Front Port Template Actions
- Interface Actions
- Interface Template Actions
- Inventory Item Actions
- Inventory Item Role Actions
- Inventory Item Template Actions
- Location Actions
- MAC Address Actions
- Manufacturer Actions
- Module Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Module Type Profile Actions
- Platform Actions
- Power Feed Actions
- Power Outlet Actions
- Power Outlet Template Actions
- Power Panel Actions
- Power Port Actions
- Power Port Template Actions
- Rack Actions
- Rack Reservation Actions
- Rack Role Actions
- Rack Type Actions
- Rear Port Actions
- Rear Port Template Actions
- Region Actions
- Site Actions
- Site Group Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
- Virtual Link Actions
Platform → Get
AI-generatedOverview
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
- Retrieve platform details by providing the platform ID in the DCIM domain.
- 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.