AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter
Join our community

Actions277

Overview

This node operation, User Agents Index, retrieves a filtered list of user agents from an external service. It allows users to query and index user agents based on various criteria such as agent state, type, version, policy, organization, network, tags, and more. This is useful for scenarios where you need to monitor, audit, or manage user agents in an IT environment, for example:

  • Listing all online Windows agents with a specific policy applied.
  • Filtering user agents by their update status or release channel.
  • Searching user agents by hostname or friendly name.
  • Sorting user agents by last synchronization time or version.

Practical examples include generating reports on device compliance, identifying offline or unprotected agents, or integrating user agent data into broader automation workflows.

Properties

Name Meaning
Additional Query Parameters Optional filters and parameters to refine the user agents list. Includes:
- Agent State Filter by agent state: Protected, Unprotected, Bypassed, Pending Uninstall, Uninstalled, Offline.
- Agent Type Filter by agent type (windows, macos, ios, android, chrome) with operators like is/isnot.
- Agent Version Filter by agent version using operators like startswith, equals, contains, etc.
- Auto Update Filter by whether the organization's auto update setting is enabled (true/false).
- Block Page Id Filter by block page ID (numeric).
- Msp Id MSP (Managed Service Provider) ID to scope results to sub-organizations (numeric).
- Name Search Search client name fields (hostname, friendly_name) with operators contains/doesnotcontain.
- Network Ids Filter by one or more network IDs (array). Defaults to all networks.
- New Agent States Whether to assign new agent states (Protected, Unprotected, Offline) (boolean).
- Organization Ids Filter by one or more organization IDs (array). Defaults to user's organization.
- Page Pagination options (page number and size) as JSON.
- Policy Id Filter by policy ID (numeric).
- Policy Schedule Filter by policy or schedule name (string).
- Release Channels Filter by release channel: stable, beta, preview with operators is/isnot.
- Scheduled Policy Id Filter by scheduled policy ID (numeric).
- Search Keyword search across status, hostname, friendly name, current logged-in user (string).
- Sort Sort results by attributes like hostname, friendly_name, agent_version, last_sync, agent_state (string).
- State Filter by online/offline state: Online or Offline.
- Status Filter by user agent status: active, disabled, uninstalled, uninstall_queued, uninstalling (string).
- Tags Filter by tags (array).
- Traffic Received Last 15 Mins Filter agents that have received traffic in the last 15 minutes (boolean).
- Type User agent type filter: Proxy or Agents (non-proxy/no-relays).

Output

The node outputs a JSON array containing user agent objects matching the specified filters. Each object typically includes details such as hostname, friendly name, agent state, version, policy information, organization, network, and other metadata relevant to the user agent.

If binary data were involved (e.g., files or images), it would be summarized here, but this operation focuses on JSON data output only.

Dependencies

  • Requires an API key credential for authenticating requests to 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

  • Empty Results: If no user agents are returned, verify that the query parameters are correct and match existing data. Check pagination settings.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Invalid Parameter Format: Some properties accept JSON input; ensure the JSON syntax is correct.
  • Network Issues: Confirm connectivity to the external API endpoint.
  • Unsupported Filters: Using invalid values or operators in filters may cause errors or empty responses.

Links and References

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

Discussion