AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node interacts with the Policies resource of the AvantGuard DNSFilter API, specifically performing the "Policies Index" operation. It retrieves a list of policies, optionally including global policies and filtering by organization ID or pagination parameters. This is useful for users who want to programmatically fetch and manage policy data from their DNS filtering service, such as auditing existing policies, displaying them in dashboards, or integrating policy information into other workflows.

Practical examples include:

  • Fetching all policies for a specific organization to review or update them.
  • Including global policies in the listing to get a comprehensive view of all applicable policies.
  • Paginating through large sets of policies to process them in batches.

Properties

Name Meaning
Additional Query Parameters Optional query parameters that can be added to customize the request:
- Include Global Policies Boolean flag to include global policies in the listing (true or false).
- Organization Id Numeric ID specifying which organization's policies to retrieve.
- Page JSON object defining pagination details such as page number and size.

Output

The node outputs JSON data representing the list of policies retrieved from the API. Each item in the output corresponds to a policy object as returned by the DNSFilter API. The structure typically includes policy attributes like IDs, names, rules, and metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the AvantGuard DNSFilter API.
  • The base URL for requests is https://api.dnsfilter.com.
  • The node uses standard HTTP headers for JSON content (Accept and Content-Type set to application/json).

Troubleshooting

  • Common issues:

    • Authentication failures due to missing or invalid API keys.
    • Incorrect organization ID leading to empty or unauthorized responses.
    • Malformed JSON in the pagination parameter causing request errors.
  • Error messages:

    • Unauthorized or 401 errors indicate problems with API credentials; verify the API key configuration.
    • 400 Bad Request errors may result from invalid query parameters; ensure JSON syntax correctness and valid values.
    • Network or timeout errors suggest connectivity issues; check internet access and API availability.

Links and References

  • AvantGuard DNSFilter API documentation (refer to official vendor docs for detailed API specs).
  • n8n documentation on creating and using API key credentials.
  • General REST API pagination best practices.

Discussion