Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the "Settings" resource of an API to retrieve information about custom domains configured for a user. It is useful in scenarios where you need to programmatically fetch and manage domain settings, such as listing all custom domains associated with a user account or filtering domains based on specific conditions.

Practical examples include:

  • Fetching all custom domains for a given user to display in a dashboard.
  • Retrieving a subset of domains using query conditions, pagination (skip/limit), and ordering.
  • Integrating domain data into workflows that automate domain management or reporting.

Properties

Name Meaning
X USER ID The User Id header value used to identify the user whose custom domains are being retrieved. This is required.
Condition A query string to filter the custom domains based on specified conditions.
Skip Number of records to skip, useful for pagination.
Limit Maximum number of records to return, useful for pagination.
Order By Specifies the order in which to sort the returned custom domains.

Output

The node outputs JSON data representing the list of custom domains retrieved from the API. Each item in the output array corresponds to a custom domain object with its associated properties as returned by the API.

If the API supports binary data related to custom domains (e.g., certificates or files), the node would handle it accordingly, but based on the provided code and properties, the output focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the external Connect Secure API service to fetch custom domain data.
  • No additional environment variables or configurations are explicitly required beyond the API authentication.

Troubleshooting

  • Missing or invalid X USER ID: Since the user ID header is required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure the correct user ID is supplied.
  • Invalid query parameters: Providing malformed or unsupported values in the condition, skip, limit, or order_by fields may result in API errors or empty responses. Validate these inputs before execution.
  • API connectivity issues: Network problems or incorrect API credentials can cause failures. Verify network access and credential validity.
  • Empty results: If no custom domains match the query conditions, the output will be empty. Adjust filters or check if domains exist for the user.

Links and References

Discussion