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 Veeam backup accounts, agents, jobs, and policies. Specifically, the Create Backup Policy operation allows users to define a new backup policy within a specified 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 or DevOps workflow.

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

Properties

Name Meaning
Subscription ID The numeric ID of the Veeam subscription under which 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 are Windows or 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 textual description of the backup policy.
Sources Optional string defining the sources (e.g., file paths or volumes) to be backed up.
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 Format of the API response; can be JSON or XML.

Output

The node outputs the API response from the Ikoula Veeam service after creating the backup policy. The output is structured as JSON by default (or XML if selected), containing details about the newly created backup policy or any error messages returned by the API.

The output is provided in the json field of the node's output data. It includes all relevant information returned by the API, such as policy identifiers, status, and configuration details.

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 makes HTTP requests to the Ikoula Veeam API endpoints.
  • Proper network access to https://api.ikoula.com or a configured API URL is necessary.

Troubleshooting

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

  • Invalid Subscription ID or Policy Parameters
    If the subscription ID or other required parameters like policy name, OS, operation mode, or backup mode are missing or incorrect, the API may return errors. Double-check input values.

  • API Request Failures
    Network issues, invalid API URLs, or permission problems can cause HTTP request failures. Verify connectivity and credential permissions.

  • Response Format Issues
    Selecting XML response format requires handling XML parsing downstream. If not handled properly, it may cause errors in subsequent nodes expecting JSON.

Links and References

If you need further details on other operations or resources, feel free to ask!

Discussion