AvantGuard - ConnectSecure icon

AvantGuard - ConnectSecure

AvantGuard - ConnectSecure

Actions223

Overview

This node operation "Get Retrieve Custom Domain" under the "Settings" resource is designed to fetch details about a specific custom domain configuration by its identifier. It is useful in scenarios where users need to programmatically retrieve information about custom domains configured in their system, such as verifying domain settings or integrating domain data into workflows.

Practical examples include:

  • Automating the retrieval of domain details for monitoring or auditing purposes.
  • Using domain information dynamically within other workflow steps, e.g., sending notifications if domain settings change.
  • Integrating with external systems that require domain metadata fetched on demand.

Properties

Name Meaning
X USER ID User Id header value to authenticate or identify the user making the request.
Id The numeric identifier of the custom domain to retrieve.

Output

The node outputs JSON data representing the details of the requested custom domain. This typically includes all relevant properties of the custom domain as returned by the API, such as domain name, status, configuration parameters, and metadata.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication (referred generically as an API authentication token).
  • Depends on the base URL configuration provided in the credentials to connect to the appropriate API endpoint.
  • Uses HTTP headers including a custom "X-USER-ID" header for user identification.

Troubleshooting

  • Missing or invalid "X USER ID" header: Ensure the "X USER ID" property is set correctly; otherwise, the API may reject the request.
  • Invalid or missing domain Id: The "Id" property must be a valid number corresponding to an existing custom domain; otherwise, the API will return an error indicating the domain was not found.
  • Authentication errors: Verify that the API authentication token is correctly configured and has sufficient permissions.
  • Network or connectivity issues: Confirm that the base URL is reachable and correct.

Common error messages might include:

  • Unauthorized or forbidden errors due to missing/invalid credentials or headers.
  • Not found errors if the domain Id does not exist.
  • Bad request errors if required parameters are missing or malformed.

Resolving these usually involves checking input values, credentials, and network configurations.

Links and References

  • Refer to the API documentation of the service managing custom domains for detailed schema and error codes.
  • n8n documentation on setting up API credentials and using HTTP headers in nodes.

Discussion