Ikoula API Veeam icon

Ikoula API Veeam

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

Overview

This node integrates with the Ikoula Veeam API to manage Veeam backup services, specifically allowing users to assign a backup policy to a backup agent. This operation is useful in scenarios where an administrator wants to enforce or update backup policies on specific backup agents within their Veeam infrastructure.

Practical examples include:

  • Assigning a predefined backup policy to a newly added backup agent.
  • Changing the backup policy of an existing backup agent to comply with updated organizational backup standards.
  • Automating backup policy assignments as part of a larger workflow managing Veeam backups.

Properties

Name Meaning
Subscription ID The numeric ID of the Veeam subscription under which the backup agent exists.
Backup ID The numeric ID of the backup agent to which the policy will be assigned.
Policy ID (For Assignment) The string ID of the backup policy that should be assigned to the specified backup agent.
Response Format The format of the API response; can be either JSON or XML.

Output

The node outputs the response from the Ikoula Veeam API after attempting to assign the backup policy. The output is structured as JSON by default (or XML if selected), containing the API's response data. This typically includes confirmation of the assignment or details about any errors encountered.

If the response is a string (e.g., raw XML), it is wrapped inside a JSON object under the data field.

No binary data output is produced by this operation.

Example output structure (JSON):

{
  "json": {
    // API response fields confirming assignment or error details
  },
  "pairedItem": 0
}

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.
  • Requires network access to https://api.ikoula.com or a configured alternative API URL.

Troubleshooting

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

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

  • API Response Errors
    Errors returned by the API (e.g., permission denied, invalid parameters) will be included in the node output. Review the error messages for guidance and check API documentation or permissions.

  • Network Issues
    Failure to reach the API endpoint due to network problems or incorrect API URL configuration will cause request failures. Confirm network connectivity and API URL correctness.

Links and References

Discussion