AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation retrieves a list of user agents from an external service, allowing filtering and sorting based on various criteria. It is useful for scenarios where you need to monitor or manage user agents connected to your network or organization, such as tracking online/offline status, filtering by tags, or searching by keywords.

Practical examples include:

  • Fetching all online user agents in specific networks.
  • Searching user agents by hostname or friendly name.
  • Sorting user agents by last synchronization time.
  • Filtering user agents by their operational state or status.

Properties

Name Meaning
Additional Query Parameters Optional parameters to refine the query:
- Network Ids Filter user agents by specific network IDs; defaults to all networks if not specified.
- Organization Ids Filter user agents by organization IDs; defaults to the user's organization ID if not specified.
- Page Pagination details including page number and size.
- Search Keyword(s) to search user agents by status, hostname, friendly name, or current logged-in user (space delimited).
- Sort Sort user agents by attributes like hostname, friendly name, agent version, or last sync time.
- State Filter user agents by their connection state; options are "Online" or "Offline".
- Status Filter by user agent status; valid values include active, disabled, uninstalled, uninstall queued, uninstalling.
- Tags Filter user agents by associated tags.
- Type User agent type filter; options are "Proxy" or "Agents" (non-proxy/no-relays user agents).

Output

The node outputs JSON data containing the list of user agents matching the query parameters. Each user agent object typically includes details such as hostname, friendly name, agent version, last synchronization time, state, status, tags, and type.

If binary data were involved (not indicated here), it would represent files or attachments related to user agents, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the external user agent management service.
  • The node uses HTTP requests to communicate with the service's REST API endpoint.
  • Proper configuration of the API base URL and authentication headers is necessary within n8n credentials.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API authentication token can cause authorization errors.
    • Invalid query parameter formats (e.g., malformed JSON in collection fields) may result in request failures.
    • Requesting pages beyond available data might return empty results.
  • Error Messages:

    • Authorization errors usually indicate invalid or expired API keys; reconfigure credentials.
    • Validation errors on query parameters suggest checking the format and allowed values.
    • Network errors imply connectivity issues or incorrect base URL settings.

Links and References

  • Refer to the external service's official API documentation for detailed descriptions of user agent attributes and query parameters.
  • n8n documentation on how to configure API credentials and use HTTP request nodes for similar integrations.

Discussion