Ikoula API VeeamInstall

Overview

This node integrates with the Ikoula Veeam API to manage Veeam backup accounts, agents, policies, and jobs. Specifically, the Install Backup Agent operation installs a backup agent through a specified management agent within a Veeam subscription.

Typical use cases include automating the deployment of backup agents on managed systems, enabling centralized control over backup infrastructure, and streamlining backup agent installation as part of broader backup management workflows.

For example, an IT administrator can use this node to programmatically install backup agents on new servers by specifying the subscription and management agent IDs, facilitating rapid scaling of backup coverage without manual intervention.

Properties

Output

The node outputs the API response in the selected format (json or xml) inside the json field of the output data. The structure depends on the API's response but generally includes details about the installation request status or any relevant metadata returned by the Ikoula Veeam API.

No binary data is produced by this operation.

Example JSON output snippet (conceptual):

{
  "status": "success",
  "message": "Backup agent installation initiated",
  "details": {
    "managementId": 123,
    "subscriptionId": 456
  }
}

Dependencies

• Requires valid credentials for the Ikoula API, including 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 Veeam API endpoint (https://api.ikoula.com by default).
• Proper API authentication credentials must be configured in n8n prior to use.

Troubleshooting

• No credentials provided!
  This error occurs if the node cannot find the required API credentials. Ensure that the Ikoula API credentials are correctly set up in n8n.

• Invalid Subscription or Management ID
  If the subscription or management agent IDs are incorrect or do not exist, the API may return errors or fail silently. Verify these IDs in your Veeam account.

• API Response Errors
  The node forwards API errors in the output JSON under an error property if continueOnFail is enabled. Check the error message for details such as authentication failure, invalid parameters, or network issues.

• Network or Connectivity Issues
  Ensure that the n8n instance has internet access and can reach the Ikoula API endpoint.

Links and References

• Ikoula Veeam API Documentation (Note: link is indicative; consult official Ikoula resources for exact API docs)
• Veeam Backup & Replication - Official product page for context on backup agents and management.