Overview
This node retrieves a list of devices from a firewall-related API (referred to as SoarApi). It is designed to fetch device information in a paginated manner, allowing users to specify how many devices to retrieve and from which starting point. This node is useful for network administrators or security analysts who want to programmatically access and process device inventories from their firewall management system.
Practical examples include:
- Automatically syncing device lists into an asset management system.
- Monitoring changes in connected devices over time.
- Feeding device data into security workflows for further analysis or alerting.
Properties
| Name | Meaning |
|---|---|
| Limit | Max number of results to return (minimum 1) |
| Offset | Number of devices to skip before starting to return results (minimum 0) |
Output
The node outputs an array containing one item per input. Each output item has a json field with the full response from the API call. The JSON structure corresponds to the list of devices returned by the API endpoint /api/pt/devices, including pagination based on the limit and offset parameters.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the firewall API (SoarApi).
- The API URL must be configured in the credentials.
- The node makes HTTP GET requests to the endpoint
${apiUrl}/api/pt/deviceswith query parameters for pagination.
Troubleshooting
- Missing or incorrect API URL: If the API URL is not set in the credentials, the node will throw an error indicating missing URL configuration.
- API request failures: Network issues, invalid credentials, or API downtime can cause request errors. The node supports "Continue On Fail" mode to allow workflow continuation despite errors.
- Invalid limit or offset values: Ensure that the limit is at least 1 and offset is zero or positive to avoid unexpected API errors.
Links and References
- Refer to your firewall API documentation for details on the
/api/pt/devicesendpoint and its response format. - n8n HTTP Request helper documentation: https://docs.n8n.io/integrations/builtin/core-nodes/n8n-nodes-base.httpRequest/