Ikoula API Platform icon

Ikoula API Platform

Interact with Ikoula Platform API for platform management. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions12

Overview

This node interacts with the Ikoula Platform API to retrieve detailed information about a specific platform. It is useful for users who want to programmatically access platform details such as configuration, status, dashboard data, servers, alerts, and other related resources managed within the Ikoula hosting environment.

A practical example would be automating monitoring or reporting workflows where you need to fetch up-to-date platform details regularly without manual intervention. For instance, you could use this node to get platform details and then trigger alerts or update dashboards in your internal systems.

Properties

Name Meaning
Platform ID The unique numeric identifier of the platform whose details you want to retrieve.
Response Format The format in which the API response should be returned. Options: JSON, XML.

Output

The node outputs an array of items, each containing a json field with the API response data. When the response format is JSON, the json field contains parsed JSON data representing the platform details. If the response format is XML, the json field contains the raw XML string under a data property.

Example output structure when JSON format is selected:

{
  "json": {
    // Platform details object as returned by the Ikoula API
  }
}

If XML format is selected, the output looks like:

{
  "json": {
    "data": "<xml>...</xml>"
  }
}

The node does not output binary data.

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 GET requests to the Ikoula API endpoints.
  • No additional external dependencies beyond standard n8n helpers and Node.js crypto module.

Troubleshooting

  • No credentials provided!
    This error occurs if the node is executed without setting up the required API authentication credentials. Ensure that you have configured the API key credential properly in n8n.

  • API request failures
    If the API returns errors (e.g., invalid platform ID, network issues), the node will throw exceptions unless "Continue On Fail" is enabled. Check that the platform ID is correct and that the API endpoint is reachable.

  • Incorrect response format
    Selecting XML format returns raw XML strings, which may require additional parsing downstream. Use JSON format for easier integration unless XML is specifically needed.

Links and References

Discussion