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 various platform-related data. Specifically, the "Get Server Items" operation fetches items associated with a particular server within a specified platform by using the platform ID and the server's IP address.

Common scenarios where this node is useful include:

  • Monitoring or managing servers within a cloud platform.
  • Retrieving detailed information about server components or resources.
  • Integrating platform server data into automated workflows for reporting or alerting.

For example, you might use this node to get all items (such as services, processes, or configurations) running on a specific server identified by its IP address in your platform, enabling further automation or analysis.

Properties

Name Meaning
Platform ID The unique numeric identifier of the platform from which to retrieve server items.
Server IP Address The IP address of the server whose items you want to fetch.
Response Format The format of the API response; can be either JSON or XML.

Output

The output is an array of objects, each containing a json field with the data returned by the Ikoula API for the requested server items.

  • If the response format is JSON, the json field contains the parsed JSON object representing the server items.
  • If the response format is XML, the json field contains the raw XML string under a data property.

No binary data output is produced by this node.

Example output structure when JSON format is selected:

{
  "json": {
    // Parsed JSON data representing server items
  }
}

If XML format is selected:

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

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 HTTP request helpers.

Troubleshooting

  • No credentials provided!
    This error occurs if the node is executed without setting up the required API credentials. Ensure that the API authentication details are correctly configured in n8n.

  • Invalid Platform ID or Server IP Address
    If the platform ID or server IP address is incorrect or does not exist, the API may return errors or empty results. Verify these inputs carefully.

  • API Response Format Issues
    Selecting XML format returns raw XML strings, which may require additional parsing downstream. Choose JSON format for easier integration unless XML is specifically needed.

  • Network or API Errors
    Network issues or API downtime can cause request failures. Check network connectivity and Ikoula API status.

Links and References

Discussion