AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node allows batch updating of domain notes in the "Domain Notes" resource. It is designed to update or append notes associated with multiple domains simultaneously, which is useful for managing large sets of domain-related metadata efficiently. Typical use cases include maintaining lists of domains with specific annotations, such as security notes, categorization tags, or operational comments.

For example, a user can provide an array of domains each paired with a note explaining its context or status, and update all these entries in one API call. This is beneficial when handling bulk updates to domain information without needing to process each domain individually.

Properties

Name Meaning
Id The unique identifier of the resource to update.
Notes An array containing objects with domain and note fields, e.g., [ { domain: 'google.com', note: '...' } ]. This specifies the domains and their corresponding notes to be updated or appended.
Additional Query Parameters Optional parameters that modify the batch update behavior:
- Append Boolean flag indicating whether to append notes (true) or overwrite existing notes (false). Defaults to true.
- Organization Ids JSON array of organization IDs to which the update applies. Defaults to the user's organization ID if not specified.
- Single Note A single note string applied to all provided domains, overriding individual notes if set.
- Type Specifies the type of list: either allow (default) or block, indicating the nature of the domain list.

Output

The node outputs JSON data representing the result of the batch update operation. This typically includes confirmation of the updated domains and notes, any errors encountered per domain, and overall status of the request. The exact structure depends on the API response but generally reflects success or failure details for each domain processed.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the external DNS filtering service.
  • The node communicates with the DNSFilter API endpoint at https://api.dnsfilter.com.
  • Proper configuration of the API key credential within n8n is necessary for successful requests.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Malformed JSON in the Notes property may lead to request errors.
    • Providing invalid domain names or unsupported types in the Type field could result in API rejections.
    • Omitting required properties like Id or Notes will prevent execution.
  • Error Messages:

    • Authentication errors usually indicate incorrect or expired API keys; verify and update credentials.
    • Validation errors from the API often point to incorrect formatting of the Notes array or query parameters; ensure JSON syntax and parameter values are correct.
    • Network or timeout errors suggest connectivity issues; check network access and API availability.

Links and References

Discussion