Ikoula API Veeam
Actions26
- Backup Actions
- Backup Policy Actions
- Management Actions
- Veeam Actions
Overview
This node interacts with the Ikoula Veeam API to manage Veeam backup accounts, agents, policies, and management agents. Specifically, the "Restart Management Agent" operation allows users to restart a management agent within a given Veeam subscription. This is useful for troubleshooting or applying configuration changes without needing to manually access the management server.
Practical scenarios include:
- Automatically restarting a management agent after configuration updates.
- Recovering from an unresponsive or malfunctioning management agent.
- Integrating management agent restarts into broader automated backup workflows.
Properties
| Name | Meaning |
|---|---|
| Subscription ID | The ID of the Veeam subscription where the management agent resides. |
| Management ID | The ID of the specific management agent to restart. |
| 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) under the json field. If JSON is selected, the output will be parsed into an object; if XML is selected, the raw XML string is provided inside the data property.
The output corresponds to the result of the restart request for the specified management agent, typically indicating success or failure status and any relevant messages from the API.
Dependencies
- Requires an API key credential for authenticating with the Ikoula Veeam API.
- The node uses Ikoula's public RSA key to encrypt the password before sending requests.
- The base URL for the API defaults to
https://api.ikoula.combut can be overridden via credentials. - Proper network connectivity to the Ikoula API endpoint is necessary.
Troubleshooting
No credentials provided!
Error thrown if the required API authentication credentials are missing. Ensure that valid credentials are configured in n8n.Invalid Subscription or Management ID
If the IDs provided do not correspond to existing resources, the API may return errors. Verify the IDs are correct and exist in your Veeam account.API Response Errors
The node passes through error messages from the API. Common issues might include permission errors, invalid parameters, or service unavailability. Check the API response details for guidance.Network Issues
Failure to reach the API endpoint due to network problems will cause errors. Confirm internet connectivity and firewall settings allow access to the Ikoula API.
Links and References
- Ikoula Veeam API Documentation (general reference, check for latest official docs)
- Veeam Backup & Replication - Official product page for context on management agents and backup operations.