Actions88
- Module Actions
- Platform Actions
- Device Actions
- Device Bay Actions
- Device Bay Template Actions
- Device Role Actions
- Device Type Actions
- Interface Actions
- Manufacturer Actions
- Module Bay Actions
- Module Bay Template Actions
- Module Type Actions
- Region Actions
- Site Actions
- Virtual Chassis Actions
- Virtual Device Context Actions
Overview
This node interacts with the NetBox API, specifically targeting the "Platform" resource within the "DCIM" domain when performing a "Get" operation. It retrieves detailed information about a specific platform by its ID. This is useful in network and data center management scenarios where you need to fetch platform details such as hardware platforms or device platforms managed in NetBox.
Practical examples include:
- Fetching platform details to verify compatibility before deploying new devices.
- Retrieving platform metadata for inventory reporting or auditing.
- Integrating platform information into automated workflows for provisioning or monitoring.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to interact with. Options: DCIM, IPAM, Tenancy, Extras, Virtualization, Circuits, Core, Users, Plugins, VPN, Wireless, Status. For this operation, it should be "dcim". |
| Platform ID | The unique identifier (ID) of the platform record to retrieve from NetBox. |
Output
The node outputs JSON data representing the platform record fetched from NetBox. This JSON contains all the fields and metadata associated with the platform identified by the given Platform ID. The structure corresponds directly to the NetBox API response for a platform object.
The node does not output binary data.
Dependencies
- Requires an active connection to a NetBox instance via an API key credential configured in n8n.
- The node depends on the NetBox API being accessible and the provided Platform ID existing in the system.
- No additional external services are required beyond the NetBox API.
Troubleshooting
Common issues:
- Invalid or missing Platform ID will result in errors or empty responses.
- Network connectivity problems or incorrect API credentials will cause authentication or connection errors.
- Using a Domain other than "dcim" or Resource other than "platforms" for this operation may lead to unexpected behavior or errors.
Error messages:
- Errors returned from the NetBox API (e.g., 404 Not Found if the platform ID does not exist).
- Authentication errors if the API key is invalid or missing.
Resolutions:
- Verify that the Platform ID is correct and exists in NetBox.
- Ensure the API key credential is properly configured and has sufficient permissions.
- Confirm the NetBox server URL and network accessibility.
- Use the correct Domain ("dcim") and Resource ("platforms") for this operation.