Ikoula API Veeam
Actions26
- Backup Actions
- Backup Policy Actions
- Management Actions
- Veeam Actions
Overview
This node integrates with the Ikoula Veeam API to manage Veeam backup accounts, agents, policies, and jobs. Specifically, the "Restart Backup Agent" operation allows users to remotely restart a backup agent associated with a Veeam subscription. This is useful in scenarios where a backup agent becomes unresponsive or requires a restart to apply updates or configuration changes.
Practical examples include:
- Automatically restarting backup agents after maintenance windows.
- Recovering from failed backup jobs by restarting the responsible agent.
- Managing multiple backup agents across different subscriptions programmatically.
Properties
| Name | Meaning |
|---|---|
| Subscription ID | The numeric ID of the Veeam subscription under which the backup agent operates. |
| Backup ID | The numeric ID of the specific backup agent to be restarted. |
| Response Format | The format of the API response returned by the node. Options: JSON, XML. |
Output
The node outputs the API response in the selected format (JSON or XML) inside the json field of the output item. For JSON responses, the data is parsed into an object; for XML, it is returned as a string within the data property.
The output structure typically includes status information about the restart request, such as success confirmation or error details.
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 endpoints.
- Proper network access to the Ikoula API endpoint (
https://api.ikoula.comby default) is necessary.
Troubleshooting
No credentials provided!
This error occurs if the node is executed without configured API credentials. Ensure that the required API authentication details are set up correctly in n8n.Invalid Subscription ID or Backup ID
If the IDs provided do not correspond to existing resources, the API may return errors. Verify that the subscription and backup agent IDs are correct.Network or API Errors
Connectivity issues or API downtime can cause request failures. Check network connectivity and Ikoula service status.Response Format Issues
Selecting XML format returns raw XML strings; ensure downstream nodes can handle XML if chosen.
Links and References
- Ikoula Veeam API Documentation (general reference, actual link may vary)
- Veeam Backup & Replication - Official product page for context on backup agents and policies