AvantGuard - DNSFilterInstall

Overview

This node interacts with the AvantGuard DNSFilter API to retrieve scheduled policies. Specifically, the "Scheduled Policies All" operation fetches a list of all scheduled policies configured in the DNSFilter system. This is useful for scenarios where you want to automate monitoring, reporting, or management of DNS filtering policies on a schedule.

Practical examples include:

• Automatically retrieving all scheduled policies to audit or synchronize them with another system.
• Generating reports on scheduled policies usage or changes over time.
• Triggering workflows based on the presence or configuration of certain scheduled policies.

Properties

The "Additional Query Parameters" property allows users to add optional query parameters to the API request. For example, you can specify pagination details by providing a JSON object like { "number": 1, "size": 50 } under the "Page" field to control which page of results is returned and how many items per page.

Output

The node outputs JSON data representing the list of scheduled policies retrieved from the API. The structure typically includes an array of policy objects, each containing details such as policy ID, name, schedule, and other relevant attributes defined by the DNSFilter API.

If the API supports binary data (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON responses.

Dependencies

• Requires an API key credential for authenticating with the AvantGuard DNSFilter API.
• The base URL for API requests is https://api.dnsfilter.com.
• The node depends on the @avantguardllc/n8n-openapi-node package for building requests based on the OpenAPI specification.
• Proper network access to the DNSFilter API endpoint is necessary.

Troubleshooting

• Common issues:

  • Authentication failures due to invalid or missing API keys.
  • Pagination errors if the "Page" parameter is malformed JSON.
  • Network connectivity problems preventing access to the API endpoint.

• Error messages:

  • Unauthorized or 401 errors indicate issues with the API key; verify credentials.
  • 400 Bad Request errors may result from incorrect query parameters; ensure JSON syntax is valid.
  • Timeout or connection errors suggest network issues; check firewall and internet access.

Links and References

• AvantGuard DNSFilter API Documentation (for detailed API endpoints and parameters)
• n8n documentation on Using API Credentials
• JSON formatting guide for query parameters: https://www.json.org/json-en.html