Ikoula API Veeam icon

Ikoula API Veeam

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

Actions26

Overview

The "Start Backup Job" operation in the Ikoula API Veeam node allows users to initiate a backup job on a specified Veeam backup agent within a subscription. This node interacts with the Ikoula Veeam API to control backup jobs programmatically.

Typical use cases include:

  • Automating backup workflows by starting backup jobs on demand.
  • Integrating backup job initiation into larger automation pipelines.
  • Managing backups across multiple Veeam subscriptions and agents without manual intervention.

For example, an IT administrator can trigger a backup job for a critical server at specific times or after certain events using this node, ensuring data protection is maintained automatically.

Properties

Name Meaning
Subscription ID The ID of the Veeam subscription where the backup agent resides.
Backup ID The ID of the backup agent on which the backup job will be started.
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 to start the backup job. The output is structured as JSON (or XML if selected), containing details about the initiated backup job status or any relevant information returned by the API.

The output is available under the json field of the node's output data. If the response is a string (e.g., XML), it is wrapped inside a data property.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Ikoula 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 Veeam API endpoint (https://api.ikoula.com by default).
  • Proper network access to the Ikoula API service is necessary.

Troubleshooting

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

  • Invalid Subscription ID, Backup ID, or Job ID
    If the IDs provided do not correspond to existing resources, the API may return errors. Verify that the IDs are correct and exist in your Veeam environment.

  • API Response Errors
    The node forwards API errors in the output JSON. Common issues might include permission problems, invalid parameters, or network connectivity issues. Review the API response message for details.

  • Response Format Issues
    Selecting XML format returns raw XML data as a string inside the data property. Ensure downstream nodes can handle this format or prefer JSON for easier processing.

Links and References

Discussion