Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node interacts with the Connect Secure API to retrieve integration rules. Specifically, the "Retrieve Integration Rules" operation fetches a list of integration rules based on optional filtering, pagination, and sorting parameters. This is useful in scenarios where users need to programmatically access or audit integration configurations, apply conditional queries to filter results, or manage large sets of integration rules by paginating through them.

Practical examples include:

  • Fetching all integration rules that meet certain conditions for reporting or monitoring.
  • Retrieving a limited number of integration rules sorted by a specific field to display in a dashboard.
  • Skipping a set number of records to paginate through integration rules in batches.

Properties

Name Meaning
X USER ID User Id header required for authentication or identification in the API request.
Condition Query condition string to filter integration rules based on specified criteria.
Skip Number of records to skip, used for pagination to offset the starting point of results.
Limit Maximum number of records to return, controlling the size of the result set.
Order By Field name(s) to order the results by, allowing sorting of the returned integration rules.

Output

The node outputs JSON data containing the retrieved integration rules matching the query parameters. The structure typically includes an array of integration rule objects, each representing a single rule with its associated properties as defined by the Connect Secure API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • The node depends on the Connect Secure API being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API credential.

Troubleshooting

  • Missing or invalid X USER ID: Since the X USER ID header is required, omitting it or providing an incorrect value will likely cause authentication or authorization errors. Ensure the user ID is correct and provided.
  • Invalid query parameters: Providing malformed or unsupported values in condition, skip, limit, or order_by 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.
  • Pagination mishandling: Using skip and limit incorrectly might lead to missing or duplicated records when paging through results. Use consistent values and ordering.

Links and References

  • Connect Secure API documentation (refer to official docs for detailed API usage and schema)
  • n8n documentation on creating and using HTTP Request nodes and custom API integrations

Discussion