Ikoula API VeeamInstall

Overview

This node interacts with the Ikoula Veeam API to manage backup jobs and related resources. Specifically, the "Stop Backup Job" operation allows users to stop a running backup job within their Veeam environment managed by Ikoula. This is useful in scenarios where a backup job needs to be halted due to errors, resource constraints, or changes in backup strategy.

Practical examples include:

• Stopping a backup job that is taking too long or consuming excessive resources.
• Halting a backup job before making configuration changes to the backup agent or policies.
• Automating backup management workflows where backup jobs are conditionally stopped based on external triggers.

Properties

Output

The node outputs the API response from the Ikoula Veeam service in the selected format (JSON or XML). When JSON is selected, the output is parsed into an object under the json field. The structure depends on the API's response for stopping a backup job, typically including status information about the job stop request.

No binary data output is produced by this operation.

Example output snippet (JSON):

{
  "json": {
    "status": "success",
    "message": "Backup job stopped successfully",
    "jobId": 12345
  }
}

Dependencies

• Requires valid credentials for the Ikoula Veeam API, including email, password, and optionally a custom API URL.
• The password is encrypted using RSA public key encryption before being sent.
• The node makes HTTP requests to the Ikoula API endpoint (https://api.ikoula.com by default).
• Proper API authentication credentials must be configured in n8n for this node to function.

Troubleshooting

• No credentials provided!
  Error thrown if the required API credentials are missing. Ensure you have configured the necessary API authentication in n8n.

• Invalid Subscription ID, Backup ID, or Job ID
  If these IDs are incorrect or do not exist, the API may return errors indicating resource not found or unauthorized access. Verify the IDs before running the node.

• API Response Errors
  The node passes through error messages from the API. Common issues might include permission errors, invalid parameters, or network connectivity problems. Check the API documentation and your network settings.

• Response Format Issues
  Selecting XML format will return raw XML strings; ensure downstream nodes can handle XML if chosen.

Links and References

• Ikoula Veeam API Documentation (Note: link is illustrative, verify actual API docs)
• Veeam Backup & Replication
• n8n HTTP Request Node Documentation (for understanding HTTP request handling)

This summary focuses on the "Stop Backup Job" operation within the Backup resource of the Ikoula API Veeam node.