AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node interacts with the AvantGuard ConnectSecure API to retrieve custom domain settings. Specifically, the "Get Retrieve Custom Domains" operation fetches a list of custom domains configured in the system. This is useful for administrators or integrators who need to programmatically access domain configurations for monitoring, auditing, or automation purposes.

Practical examples include:

  • Automatically syncing custom domain data into an internal dashboard.
  • Validating domain configurations before deploying new services.
  • Extracting domain information for compliance reporting.

Properties

Name Meaning
X USER ID The user identifier required by the API to authenticate or specify the user context.
Additional Query Parameters Optional parameters to refine the query results:
- Condition: Filter condition for querying domains.
- Skip: Number of records to skip (for pagination).
- Limit: Maximum number of records to return.
- Order By: Field name to order the results by.

Output

The node outputs JSON data representing the retrieved custom domains. Each item in the output corresponds to a custom domain record as returned by the API. The structure typically includes domain details such as domain name, status, and related metadata.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for AvantGuard ConnectSecure to authenticate requests.
  • Needs the base URL of the AvantGuard ConnectSecure API configured in the credentials.
  • Uses the @avantguardllc/n8n-openapi-node package internally to build request properties from the OpenAPI specification.

Troubleshooting

  • Missing or invalid X USER ID: The API requires a valid user ID header; ensure this property is set correctly.
  • API authentication errors: Verify that the API key credential is properly configured and has necessary permissions.
  • Query parameter issues: Incorrect values in additional query parameters (e.g., non-numeric skip/limit) may cause request failures.
  • Network or connectivity problems: Ensure the base URL is reachable from the n8n instance.

Common error messages will likely relate to authentication failure, missing headers, or invalid query parameters. Resolving these involves checking credentials, input property correctness, and network accessibility.

Links and References

  • AvantGuard ConnectSecure API documentation (refer to your organization's API docs)
  • n8n documentation on creating and using API credentials
  • OpenAPI specification used internally (not publicly linked here)

Discussion