Ikoula API Platform
Actions12
Overview
This node interacts with the Ikoula Platform API to manage and retrieve information about platforms hosted on Ikoula. Specifically, the "List Platform Alerts" operation fetches alerts associated with a given platform. This is useful for monitoring platform health, identifying issues, or automating alert-based workflows.
Practical examples include:
- Automatically retrieving current alerts for a platform to trigger notifications.
- Integrating platform alert data into dashboards or incident management systems.
- Periodically checking for new alerts to maintain operational awareness.
Properties
| Name | Meaning |
|---|---|
| Platform ID | The unique numeric identifier of the platform for which alerts are to be listed. |
| Response Format | The format in which the API response should be returned. Options: JSON, XML. |
Output
The node outputs an array of items where each item contains a json field holding the API response data. For the "List Platform Alerts" operation, this JSON includes the list of alerts related to the specified platform.
If the response format is set to JSON, the output will be parsed JSON objects representing the alerts. If XML is chosen, the raw XML string is returned inside the data property of the JSON output.
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 external dependencies beyond standard n8n HTTP request helpers.
Troubleshooting
- No credentials provided!: This error occurs if the node is executed without proper API credentials configured. Ensure that the required API authentication details are set up in n8n.
- API request failures: Network issues, invalid platform IDs, or incorrect response format settings may cause errors. Verify platform IDs and network connectivity.
- Unexpected response format: If XML is selected but downstream nodes expect JSON, parsing errors may occur. Choose the response format according to your workflow needs.
- Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.
Links and References
- Ikoula API Documentation (general reference for API endpoints and usage)
- n8n HTTP Request Node Documentation (for understanding HTTP request handling in n8n)