Ikoula Zimbra API icon

Ikoula Zimbra API

Interact with Ikoula Zimbra API for Zimbra email services management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions2

Overview

This node interacts with the Ikoula Zimbra API to manage Zimbra email services. Specifically, the "Get Account Details" operation retrieves detailed information about a specific Zimbra account associated with a given subscription ID. This is useful for administrators or automation workflows that need to fetch account-specific data such as configuration, status, or usage details from the Zimbra service.

Practical examples include:

  • Automatically retrieving account details to verify subscription status before performing further actions.
  • Integrating Zimbra account information into dashboards or reporting tools.
  • Triggering alerts or updates based on account properties fetched dynamically.

Properties

Name Meaning
Subscription ID The unique numeric identifier of the Zimbra service subscription whose account details are requested.
Response Format The format in which the API response will be returned. Options: JSON or XML.

Output

The node outputs the response from the Ikoula Zimbra API under the json field. Depending on the selected response format:

  • If JSON is chosen, the output will be a parsed JSON object containing the account details.
  • If XML is chosen, the output will be a string containing the raw XML response.

The output is structured as an array of items, each with a json property holding the API response data or error information if the request failed.

No binary data output is produced by this node.

Dependencies

  • Requires valid credentials for the Ikoula API, including an email, password, and optionally a custom API URL.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node makes HTTP GET requests to the Ikoula API endpoint (https://api.ikoula.com by default).
  • Proper n8n credential setup is necessary to provide the required authentication details.

Troubleshooting

  • No credentials provided!
    This error occurs if the node cannot find the required API credentials. Ensure that the API key credential is configured correctly in n8n.

  • HTTP request failures
    Network issues, incorrect subscription IDs, or invalid credentials can cause request errors. Verify the subscription ID is correct and the API credentials are valid.

  • Response format issues
    Selecting XML format returns raw XML strings; downstream nodes expecting JSON may fail. Use JSON format unless XML is specifically needed.

  • Encryption errors
    The password is encrypted with a hardcoded RSA public key. If the API changes its key, authentication will fail. Confirm the public key matches the current API requirements.

Links and References

Discussion