Ikoula API Platform
Actions12
Overview
This node interacts with the Ikoula Platform API to retrieve dashboard information for a specified platform. It is designed to fetch detailed metrics and status data that provide insights into the platform's current state and performance.
Common scenarios where this node is beneficial include:
- Monitoring platform health and usage statistics in real-time.
- Integrating platform dashboard data into custom workflows or reporting tools.
- Automating alerts or actions based on platform status changes.
For example, a user can configure this node to regularly pull the dashboard data of a hosting platform to track resource utilization and trigger notifications if certain thresholds are exceeded.
Properties
| Name | Meaning |
|---|---|
| Platform ID | The unique numeric identifier of the platform for which the dashboard data is requested. |
| Response Format | The format of the API response. Options: JSON (default) or XML. |
Output
The node outputs an array of items, each containing a json field with the platform dashboard data retrieved from the API.
- If the response format is JSON, the
jsonfield contains a parsed JSON object representing the dashboard details. - If the response format is XML, the
jsonfield contains the raw XML string under adataproperty.
No binary data output is produced by this node.
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 environment variables are required beyond the configured API credentials.
Troubleshooting
No credentials provided!
This error occurs if the node is executed without proper API credentials configured. Ensure that the API key credential is set up correctly in n8n.HTTP request failures
Network issues, invalid platform IDs, or incorrect API URLs may cause request errors. Verify the platform ID exists and the API endpoint is reachable.Invalid response format
Selecting XML format returns raw XML as a string; downstream nodes expecting JSON must handle this accordingly.Continue On Fail behavior
If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output.
Links and References
- Ikoula API Documentation (general reference for API endpoints and authentication)
- n8n HTTP Request Node (for understanding underlying HTTP calls)