Ikoula API Veeam icon

Ikoula API Veeam

Interact with Ikoula Veeam API for backup management. Developed by Ascenzia - www.ascenzia.fr

Overview

This node integrates with the Ikoula Veeam API to manage backup operations, specifically allowing users to start backup jobs among other backup-related tasks. It is useful in scenarios where automated control over Veeam backup jobs is required, such as triggering backups on-demand, managing backup policies, or administrating backup agents programmatically within an n8n workflow.

For example, a user can configure this node to start a specific backup job for a given subscription and backup agent, enabling automated backup workflows triggered by events or schedules.

Properties

Name Meaning
Subscription ID The ID of the Veeam subscription to which the backup job belongs.
Backup ID The ID of the backup agent associated with the backup job.
Job ID The ID of the specific backup job to start.
Response Format The format of the API response returned by the node. Options: JSON, XML.

Output

The node outputs the response from the Ikoula Veeam API call in the json field. The structure depends on the chosen response format:

  • If JSON is selected, the output will be a parsed JSON object representing the API response data.
  • If XML is selected, the output will contain the raw XML response as a string under the data property.

The output corresponds to the result of starting the specified backup job, typically including status information about the job initiation.

Dependencies

  • Requires valid credentials for the Ikoula Veeam API, including an email, password, and API URL.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node makes HTTP requests to the Ikoula API endpoint (default: https://api.ikoula.com).
  • Proper configuration of the API credentials in n8n is necessary for successful operation.

Troubleshooting

  • No credentials provided!
    This error occurs if the node is executed without configured API credentials. Ensure that the Ikoula Veeam API credentials are set up correctly in n8n.

  • Invalid IDs (Subscription ID, Backup ID, Job ID)
    Providing incorrect or non-existent IDs will cause the API request to fail. Verify that all IDs correspond to existing resources in your Veeam environment.

  • API response errors
    Errors returned by the API (e.g., unauthorized, not found) will be included in the node output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check the API response message for details and verify credentials and parameters.

  • Response format issues
    Selecting XML format returns raw XML strings, which may require additional parsing downstream in your workflow.

Links and References

Discussion