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 to list platform entries. It allows users to retrieve a collection of platform data from their NetBox instance, which is useful for inventory management, automation workflows, or integration scenarios where platform information is needed.
Common use cases include:
- Fetching all available platforms or a subset based on filters for reporting or synchronization.
- Automating infrastructure documentation by pulling platform details.
- Integrating platform data into other systems or dashboards.
For example, a user might want to list all platforms manufactured by a specific vendor or filter platforms by name or tag to process them further in an automation workflow.
Properties
| Name | Meaning |
|---|---|
| Domain | The domain of the NetBox API to target; for this operation, it should be "DCIM". |
| Return All | Whether to return all matching results or limit the number of returned items. |
| Limit | Maximum number of results to return if "Return All" is false (minimum 1, default 50). |
| Filters | Collection of optional filters to narrow down the list of platforms: |
| Platform ID | Filter by exact platform ID (number). |
| Name | Filter by platform name (string). |
| Slug | Filter by platform slug (string). |
| Description | Filter by description text (string). |
| Manufacturer ID | Filter by manufacturer ID (number). |
| Manufacturer Name | Filter by manufacturer name slug (string). |
| NAPALM Driver | Filter by NAPALM driver name (string). |
| Tag | Filter by tag (string). |
Output
The node outputs JSON data representing the list of platforms retrieved from the NetBox API. Each item in the output array corresponds to a platform object containing its properties as defined by the NetBox API schema (e.g., id, name, slug, manufacturer, description, etc.).
If binary data were involved, it would be summarized here, but this node deals exclusively with JSON data.
Dependencies
- Requires access to a NetBox instance with the appropriate API enabled.
- Needs an API authentication token credential configured in n8n to authorize requests to the NetBox API.
- No additional external services are required beyond the NetBox API.
Troubleshooting
Common issues:
- Authentication failures due to missing or invalid API tokens.
- Network connectivity problems preventing access to the NetBox server.
- Incorrect filter values leading to empty result sets.
- Exceeding API rate limits or permissions restricting access to certain resources.
Error messages:
- Errors during execution will be logged to the console.
- If "Continue on Fail" is enabled, errors will be returned as part of the node's output JSON under an
errorfield. - To resolve errors, verify API credentials, network access, and filter correctness.