AvantGuard - DNSFilterInstall

Overview

This node operation allows users to add a domain to the whitelist of a specific policy in the AvantGuard DNSFilter system. Whitelisting a domain means that the domain will be exempt from filtering or blocking rules defined by the policy, allowing traffic to and from that domain without restriction.

Common scenarios for this node include:

• Allowing trusted domains that are mistakenly blocked by DNS filtering policies.
• Adding partner or internal company domains to ensure uninterrupted access.
• Managing exceptions dynamically as new safe domains need to be added to existing policies.

For example, a security administrator can use this node to add "example.com" to the whitelist of a policy with ID 123, ensuring users governed by that policy can access the domain freely.

Properties

Output

The node outputs JSON data representing the updated policy after the domain has been added to its whitelist. This typically includes details about the policy itself, the newly whitelisted domain, and optionally any related entities if requested.

If the API supports it, the output may also contain metadata about the operation's success or failure.

No binary data output is expected from this operation.

Dependencies

• Requires an API key credential for authenticating with the AvantGuard DNSFilter API.
• The node uses the base URL https://api.dnsfilter.com for making requests.
• Proper network connectivity to the AvantGuard DNSFilter service is necessary.
• The user must have appropriate permissions to modify policies in the DNSFilter system.

Troubleshooting

• Invalid Policy ID: If the provided policy ID does not exist or is incorrect, the API will likely return an error. Verify the policy ID before running the node.
• Domain Format Errors: Ensure the domain string is valid and properly formatted (e.g., no protocol prefix like "http://").
• Authentication Failures: Check that the API key credential is correctly configured and has not expired.
• Permission Denied: The authenticated user might lack rights to modify the specified policy; verify user permissions.
• Network Issues: Timeouts or connection errors indicate network problems or API endpoint unavailability.

Error messages returned by the API should be reviewed to identify the exact cause, and retry or correction steps applied accordingly.

Links and References

• AvantGuard DNSFilter API Documentation (general reference for API endpoints and payloads)
• n8n Documentation on Creating Custom Nodes and Using Credentials