Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node performs an external scan operation by sending a request to an external endpoint, typically used for security or discovery purposes. It is designed to interact with an API that requires user identification and company context, along with customizable discovery settings. Common scenarios include scanning external systems for vulnerabilities, gathering metadata about external resources, or triggering external security scans.

Practical examples:

  • Initiating a security scan on an external service using a specific user ID and company context.
  • Sending custom discovery parameters in JSON format to tailor the scan behavior.
  • Automating external endpoint scans as part of a larger workflow for compliance or monitoring.

Properties

Name Meaning
X USER ID User identifier sent as a header (X-USER-ID) to authenticate or identify the user.
Company Id Numeric identifier representing the company context; sent in the request body.
Discovery Settings JSON object containing configuration for the discovery process; sent in the request body.

Output

The node outputs JSON data representing the response from the external scan endpoint. This typically includes scan results, status information, or any data returned by the external API after processing the scan request.

If the external API returns binary data (e.g., reports or files), it would be included in the binary output field, but this is not explicitly indicated in the provided code.

Dependencies

  • Requires an API key credential for authentication with the external Connect Secure API.
  • Depends on the external API described by the bundled OpenAPI specification (openapi.json).
  • The node uses routing to map input properties to HTTP headers and body fields according to the API requirements.

Troubleshooting

  • Missing or invalid X USER ID header: The external API may reject requests without a valid user ID header. Ensure this property is set correctly.
  • Invalid Company Id value: The company ID must be a valid number; otherwise, the API might return errors.
  • Malformed Discovery Settings JSON: Since this property expects JSON, invalid JSON syntax will cause parsing errors before the request is sent.
  • Authentication failures: Verify that the API key credential is configured properly in n8n.
  • Unexpected API responses: Check the external API documentation for error codes and messages if the scan fails.

Links and References

Discussion