AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node interacts with a Backup Software API to retrieve backup software data for a specified user. It is designed to fetch records related to backup software configurations or statuses, filtered and paginated according to user-defined query parameters.

Common scenarios include:

  • Retrieving a list of backup software entries associated with a particular user.
  • Filtering backup software records based on conditions such as status or date.
  • Paginating results when dealing with large datasets.
  • Sorting the retrieved backup software data by specific fields.

Practical example:
A system administrator wants to get all backup software entries for user ID "12345", skipping the first 10 records, limiting the output to 20 entries, and ordering them by creation date.

Properties

Name Meaning
X USER ID The unique identifier of the user whose backup software data is being retrieved.
Additional Query Parameters Optional filters and controls for the query:
- Condition A string representing query conditions to filter the backup software records.
- Skip Number of records to skip (for pagination).
- Limit Maximum number of records to return.
- Order By Field name(s) to order the results by (e.g., "createdAt DESC").

Output

The node outputs JSON data containing the retrieved backup software records matching the query parameters. Each item in the output JSON array represents a backup software entry with its associated properties as returned by the API.

If the API supports binary data (not indicated here), it would typically represent downloadable backup files or logs; however, this node focuses on JSON metadata retrieval.

Dependencies

  • Requires an API key credential for authenticating requests to the Backup Software service.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP headers to pass the user ID and query parameters to the API endpoint.

Troubleshooting

  • Missing or invalid X USER ID: The node requires a valid user ID header. Ensure the "X USER ID" property is set correctly.
  • API authentication errors: Verify that the API key credential is properly configured and has sufficient permissions.
  • Query parameter issues: Invalid values in condition, skip, limit, or order_by may cause API errors. Validate these inputs before execution.
  • Empty results: If no backup software records are returned, check the query conditions and user ID for correctness.
  • Network or connectivity problems: Confirm that the base URL is reachable from the n8n environment.

Links and References

  • Refer to the Backup Software API documentation for details on supported query parameters and response structure.
  • Consult n8n documentation on how to configure API key credentials and HTTP request nodes for further customization.

Discussion