Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

This node integrates with a Backup Software API to create backup configurations or entries. It is designed to send user-specific data to the backup service, enabling automated creation of backups based on provided parameters. This node is useful in scenarios where users want to programmatically manage backup setups, such as scheduling backups, defining backup rules, or integrating backup creation into larger automation workflows.

For example, a user can specify their user ID and provide JSON data describing backup options (like whether to use regex patterns or exclude certain files), and the node will create a corresponding backup configuration in the external Backup Software system.

Properties

Name Meaning
X USER ID The User Id header value used for authentication or identification in the API request.
Data JSON object containing backup configuration details. Options include:
- regex: boolean indicating if regex patterns are used in backup rules.
- exculde (likely a typo for "exclude"): boolean indicating if certain items are excluded from backup.

Output

The node outputs JSON data representing the response from the Backup Software API after creating the backup. This typically includes confirmation details about the created backup, such as an identifier, status, or any metadata returned by the API.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key or token credential to authenticate with the Backup Software API.
  • The node uses HTTP headers to pass the user ID (X-USER-ID) and sends JSON data in the request body.
  • No additional external libraries beyond standard n8n dependencies and the bundled OpenAPI client are required.

Troubleshooting

  • Common issues:
    • Missing or incorrect X USER ID header may cause authentication failures.
    • Malformed JSON in the Data property can lead to request errors.
    • Typo in the property name exculde might cause unexpected behavior; verify if the API expects exclude.
  • Error messages:
    • Authentication errors likely indicate missing or invalid user ID or API credentials.
    • Validation errors may occur if the JSON data does not conform to expected schema.
  • Resolutions:
    • Ensure the X USER ID is correctly set and valid.
    • Validate JSON input before execution.
    • Confirm property names match the API specification.

Links and References

  • Refer to the Backup Software API documentation for detailed information on the expected JSON structure and available backup options.
  • Consult n8n documentation on how to configure HTTP headers and JSON body properties in custom nodes.

Discussion