AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation, "Get Retrieve Asset Ports" under the "Asset Data" resource, is designed to fetch information about asset ports from an external system via an API. It is useful in scenarios where users need to programmatically retrieve detailed port data related to specific assets, such as network devices or hardware components, for monitoring, inventory management, or integration with other systems.

For example, a network administrator could use this node to automatically gather port configurations and statuses from managed devices to update a central database or trigger alerts based on port conditions.

Properties

Name Meaning
X USER ID User identifier required for authentication or access control in the API request headers.
Additional Query Parameters Optional parameters to refine the query:
- Condition: A filter condition to limit results.
- Skip: Number of records to skip (for pagination).
- Limit: Maximum number of records to return.
- Order By: Field(s) to order the results by.

Output

The node outputs JSON data representing the retrieved asset ports. Each item in the output corresponds to a port associated with an asset, containing details as provided by the external API. The exact structure depends on the API response but typically includes port identifiers, status, configuration, and related metadata.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an API key credential for authenticating requests to the external service.
  • The base URL for the API must be configured in the node credentials.
  • Uses the @avantguardllc/n8n-openapi-node package and an OpenAPI specification (openapi.json) bundled with the node for request building and validation.

Troubleshooting

  • Missing or invalid X USER ID: Since the user ID header is required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure the correct user ID is supplied.
  • Invalid query parameters: Providing malformed or unsupported query parameters may result in API errors or empty responses. Validate parameter values before execution.
  • API connectivity issues: Network problems or incorrect base URL configuration can prevent successful API calls. Verify network access and credential settings.
  • Rate limiting or permission errors: If the API enforces rate limits or permissions, exceeding these may cause errors. Check API usage policies and credentials.

Links and References

  • No direct links are available from the source code. For more information, consult the documentation of the external API service used by this node or the @avantguardllc/n8n-openapi-node package if applicable.

Discussion