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 jobs and related resources. Specifically, the Delete Backup Job operation allows users to delete a specific backup job within a Veeam subscription and backup agent context.

Typical use cases include automating cleanup of obsolete or failed backup jobs, managing backup lifecycle programmatically, or integrating backup job management into broader IT workflows.

For example, an IT administrator could use this node in an automation workflow to delete backup jobs that have completed successfully or are no longer needed, freeing up resources and maintaining a clean backup environment.

Properties

Name Meaning
Subscription ID The numeric ID of the Veeam subscription under which the backup job exists.
Backup ID The numeric ID of the backup agent associated with the backup job.
Job ID The numeric ID of the backup job to be deleted.
Response Format The format of the API response returned by the node. Options: JSON, XML.

Output

The node outputs the response from the Ikoula Veeam API after attempting to delete the specified backup job. The output is available in the json field of the node's output data.

  • If the response format is JSON, the output will be a parsed JSON object representing the API's response.
  • If the response format is XML, the output will contain the raw XML string data.
  • The output includes any success confirmation or error details returned by the API.

No binary data is produced by this operation.

Dependencies

  • Requires valid credentials for the Ikoula API, including email, password, and API URL (defaulting to https://api.ikoula.com if not provided).
  • 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 the Ikoula API endpoint is necessary.
  • The user must configure the node with an API authentication credential containing the required login information.

Troubleshooting

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

  • Invalid Subscription ID, Backup ID, or Job ID
    If the IDs provided do not correspond to existing resources, the API may return errors indicating resource not found. Verify the correctness of these IDs.

  • API Response Errors
    The node returns the API's error messages in the output JSON. Common issues might include permission denied, invalid parameters, or network connectivity problems.

  • Response Format Issues
    Selecting XML as the response format will return raw XML strings, which may require additional parsing downstream.

  • Network or Endpoint Issues
    Ensure that the API URL is reachable and correct. Network firewalls or proxy settings might block access.

Links and References

Discussion