AvantGuard - DNSFilter icon

AvantGuard - DNSFilter

AvantGuard - DNSFilter

Actions277

Overview

This node operation updates a User Agent Cleanup job. It allows you to modify the status and parameters of an existing cleanup task that manages user agent data, typically used for maintenance or data hygiene purposes. Common scenarios include restarting a cleanup job or adjusting how long a user agent is considered inactive before being processed for deletion.

For example, you might use this node to restart a cleanup job after changing its inactivity threshold or to pause/resume the cleanup process based on operational needs.

Properties

Name Meaning
Id The unique identifier of the user agent cleanup job to update.
Additional Body Fields Optional fields to customize the update:
- Start Boolean flag to start the cleanup job. If set to true, it initiates the cleanup unless inactive_for is specified.
- Inactive For Number of days a user agent must be inactive before the cleanup job restarts to find records to delete.

Output

The node outputs JSON data representing the response from the update operation on the user agent cleanup job. This typically includes confirmation of the updated fields and the current state of the cleanup job after the update.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authentication with the external service managing user agent cleanups.
  • The node communicates with a REST API endpoint (not explicitly shown in the code snippet) to perform the update operation.
  • Proper configuration of the API base URL and headers is necessary, usually handled by the node's internal setup.

Troubleshooting

  • Common Issues:

    • Providing an invalid or non-existent cleanup job Id will likely result in an error indicating the resource was not found.
    • Omitting required fields such as the Id will cause validation errors.
    • Incorrect data types for fields like start (should be boolean) or inactive_for (should be number) may cause request failures.
  • Error Messages:

    • "Resource not found" or similar indicates the specified cleanup job Id does not exist.
    • "Invalid input" errors suggest that one or more provided properties do not meet expected formats or constraints.
  • Resolutions:

    • Verify the cleanup job Id exists before attempting an update.
    • Ensure all required fields are provided and correctly typed.
    • Check API credentials and network connectivity if authentication or communication errors occur.

Links and References

  • No direct links available from the source code.
  • Refer to the external API documentation of the user agent cleanup service for detailed information on supported fields and behaviors.

Discussion