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 interacts with the Ikoula Veeam API to manage backup operations, specifically allowing users to restart a backup agent among other backup-related tasks. The "Restart Backup Agent" operation sends a request to restart a specified backup agent within a given Veeam subscription. This is useful in scenarios where a backup agent becomes unresponsive or requires a reset to resume normal operation.

Practical examples include:

  • Restarting a backup agent after configuration changes.
  • Recovering a backup agent that has stopped working without manual intervention.
  • Automating maintenance workflows for backup infrastructure.

Properties

Name Meaning
Subscription ID The ID of the Veeam subscription to which the backup agent belongs.
Backup ID The ID of the backup agent that needs to be restarted.
Response Format The format of the API response returned by the node. Options: JSON, XML.

Output

The node outputs the API response in the selected format (JSON or XML) under the json field. If the response is JSON, it will be parsed into an object; if XML, it will be returned as a string inside the data property. The output corresponds to the result of the restart operation on the backup agent, typically indicating success or failure status and any relevant messages from the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authentication with the Ikoula Veeam API.
  • The node uses RSA public key encryption to encrypt the password before sending requests.
  • The base URL for the API defaults to https://api.ikoula.com but can be overridden via credentials.
  • Proper network access to the Ikoula API endpoint is necessary.

Troubleshooting

  • No credentials provided!
    Error occurs if the required API credentials are missing. Ensure that valid credentials with email, password, and API URL are configured in n8n.

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

  • API Response Errors
    The node forwards error messages from the API. Common issues might include permission errors, invalid parameters, or service unavailability. Check the API documentation and ensure the account has sufficient rights.

  • Network Issues
    Failure to reach the API endpoint due to network problems will cause errors. Confirm internet connectivity and firewall settings.

Links and References

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

Discussion