Ikoula API Veeam icon

Ikoula API Veeam

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

Overview

This node interacts with the Ikoula Veeam API to manage Veeam backup and management agents. Specifically, the "Restart Management Agent" operation allows users to remotely restart a management agent within their Veeam infrastructure. This can be useful for troubleshooting or applying configuration changes without manual intervention on the target machine.

Practical scenarios include:

  • Automatically restarting a management agent after configuration updates.
  • Recovering from an unresponsive or malfunctioning management agent.
  • Integrating restart operations into broader automated workflows for backup management.

Properties

Name Meaning
Subscription ID The numeric ID of the Veeam subscription under which the management agent exists.
Management ID The numeric ID of the specific management agent to restart.
Response Format The format in which the API response is returned. Options: JSON, XML.

Output

The node outputs the API response in the selected format (json or xml) inside the json field of the output data. If JSON is selected, the response is parsed into an object; if XML is selected, the raw XML string is returned under the data property.

Example JSON output structure (simplified):

{
  "json": {
    // API response content confirming restart action or error details
  }
}

No binary data output is produced by this operation.

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 or a user-specified URL.
  • Proper API authentication credentials must be configured in n8n prior to use.

Troubleshooting

  • No credentials provided!
    Error thrown if the required API credentials are missing. Ensure that the API key credential is properly set up in n8n.

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

  • API connectivity issues
    Network problems or incorrect API URLs can cause request failures. Confirm network access and API endpoint correctness.

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

Links and References


This summary focuses on the "Management" resource and the "Restart Management Agent" operation as requested.

Discussion