AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation creates a CSV export of user agent data filtered by various criteria. It is useful for generating reports or backups of user agent information from a network or organization, especially when you want to analyze or archive user agent details in a structured CSV format.

Typical use cases include:

  • Exporting user agent lists filtered by type (proxy or agents).
  • Filtering user agents by network IDs, tags, status, or online/offline state.
  • Searching user agents by hostname or friendly name.
  • Exporting only those agents that have received traffic recently.

For example, a network administrator might use this node to export all active proxy user agents within certain networks that have been online and received traffic in the last 15 minutes.

Properties

Name Meaning
Additional Body Fields Optional additional fields to customize the export request body. Includes:
- User Agent Csv Export JSON object specifying attributes like organization IDs and specific user agent IDs to include in the export.
- Network Ids JSON array of network IDs to filter user agents by; defaults to all networks if empty.
- Type User agent type to export. Options: proxy (default) or agents.
- Search String keywords (space delimited) to search user agents by hostname or friendly name.
- Name Search A string term specifically to search client name fields such as hostname and friendly name.
- Tags JSON array of tags to filter user agents by.
- Status Filter user agents by status. Valid values include active, disabled, and uninstalled.
- State Filter user agents by online/offline state. Options: online (default), offline.
- Agent State Filter by agent state. Options: protected (default), unprotected, bypassed, uninstalled.
- Traffic Received Last 15 Mins Boolean flag to filter agents that have received traffic in the last 15 minutes. Defaults to true.

Output

The node outputs JSON data representing the result of the CSV export creation request. The exact structure depends on the API response but typically includes metadata about the export job or a link to download the generated CSV file.

If binary data output is supported, it would represent the actual CSV file content, but based on the provided code and properties, the output is primarily JSON describing the export operation.

Dependencies

  • Requires an API key credential for authentication with the external service managing user agent data.
  • The node uses a REST API endpoint at https://api.dnsfilter.com (implied by bundled source) to perform the export operation.
  • Proper configuration of the API key credential in n8n is necessary for successful requests.

Troubleshooting

  • Invalid JSON in Additional Body Fields: Since some properties expect JSON input, malformed JSON will cause errors. Ensure JSON fields are correctly formatted.
  • Empty or Incorrect Filters: Providing filters that do not match any user agents may result in empty exports. Verify filter values such as network IDs, tags, and statuses.
  • Authentication Errors: Missing or invalid API credentials will cause authorization failures. Confirm the API key is set up correctly.
  • API Rate Limits or Downtime: If the external API is rate-limited or down, requests may fail. Check API status and retry later.
  • Incorrect Property Types: For example, setting boolean fields as strings may cause unexpected behavior. Use correct types as specified.

Links and References

Discussion