Ikoula API VeeamInstall

Overview

This node integrates with the Ikoula Veeam API to manage Veeam backup accounts and related resources such as agents, backup policies, and management agents. Specifically, the "List Veeam Agents" operation retrieves a list of backup agents associated with a specified Veeam subscription.

Common scenarios for this node include:

• Monitoring all backup agents under a Veeam subscription to ensure they are active and properly configured.
• Automating inventory or reporting of backup agents in an infrastructure.
• Integrating backup agent data into broader workflows for backup management or alerting.

For example, a user can automate the retrieval of all Veeam agents for a subscription and then trigger notifications if any agents are offline or require attention.

Properties

Output

The output contains a JSON object representing the API response from the Veeam service listing the agents for the specified subscription. The structure depends on the API but typically includes details about each agent such as its ID, status, name, and other metadata.

If the response format is set to XML, the raw XML string is returned inside the data field of the JSON output.

Example JSON output snippet (conceptual):

{
  "agents": [
    {
      "id": 123,
      "name": "Agent1",
      "status": "active",
      "lastSeen": "2024-06-01T12:00:00Z"
    },
    {
      "id": 124,
      "name": "Agent2",
      "status": "inactive",
      "lastSeen": "2024-05-30T08:30:00Z"
    }
  ]
}

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.
• No additional external dependencies beyond standard n8n credential and HTTP request mechanisms.

Troubleshooting

• No credentials provided!
  This error occurs if the required API credentials are missing or not configured correctly in n8n. Ensure that the API authentication details are set up properly.

• HTTP request failures (e.g., network errors, unauthorized access)
  Verify that the subscription ID is correct and that the API credentials have sufficient permissions. Also check network connectivity and API endpoint availability.

• Invalid response format
  If the response format is set to XML but downstream nodes expect JSON, parsing errors may occur. Use JSON format unless XML is specifically needed.

• Continue On Fail behavior
  If enabled, the node will return error messages in the output JSON instead of stopping execution, allowing workflows to handle errors gracefully.

Links and References

• Ikoula Veeam API Documentation (general reference, actual link may vary)
• Veeam Backup & Replication Documentation
• n8n HTTP Request Node Documentation (for understanding underlying HTTP calls)