Ikoula API Veeam icon

Ikoula API Veeam

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

Actions26

Overview

This node integrates with the Ikoula Veeam API to manage backup policies and related operations. Specifically, the Create Backup Policy operation allows users to define a new backup policy within their Veeam subscription. This is useful for automating backup configurations in cloud or on-premises environments managed by Veeam through Ikoula's API.

Typical use cases include:

  • Automating the creation of backup policies for different operating systems (Windows or Linux).
  • Scheduling backups with specific timing and recurrence.
  • Defining backup sources and modes programmatically as part of an infrastructure-as-code workflow.
  • Integrating backup policy management into larger automation workflows in n8n.

For example, a user can create a backup policy that runs every day at 00:30 for Windows servers, specifying the backup mode and operation mode, along with optional descriptions and source paths.

Properties

Name Meaning
Subscription ID The ID of the Veeam subscription where the backup policy will be created.
Policy Name The name assigned to the new backup policy.
Operating System The OS targeted by the backup policy. Options: Windows, Linux.
Operation Mode The operation mode setting for the backup policy (string value defined by the API).
Backup Mode The backup mode setting for the policy (string value defined by the API).
Description Optional description text for the backup policy.
Sources Optional string defining the sources to back up (e.g., file paths or volumes).
Schedule Mode Optional schedule mode for the backup policy (e.g., manual, automatic).
Schedule Day Optional day(s) when the backup should run. Default is "EveryDay".
Schedule Time Optional time of day for the backup in HH:MM format. Default is "00:30".
Response Format The format of the API response. Options: JSON, XML. Default is JSON.

Output

The node outputs the API response from the Ikoula Veeam service after creating the backup policy. The output is available in the json field of the returned item.

  • If the response format is JSON, the output will be a parsed JSON object representing the newly created backup policy details or any error messages.
  • If the response format is XML, the output will be a raw XML string under the data property inside the json output.

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 uses HTTP requests to communicate with the Ikoula Veeam API endpoints.
  • No additional external dependencies beyond standard n8n credential and HTTP request helpers.

Troubleshooting

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

  • Invalid Subscription ID or parameters
    If the subscription ID or other required parameters are incorrect or missing, the API may return errors. Double-check all input values.

  • API response errors
    Errors returned from the Ikoula API (e.g., invalid operation mode, backup mode, or scheduling parameters) will be included in the node output. Review the API documentation for valid parameter values.

  • Network or connectivity issues
    Ensure that the n8n instance has network access to the Ikoula API endpoint (https://api.ikoula.com or custom URL).

Links and References

Discussion