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 Platform Status" operation fetches the current status of a specified platform by its ID. This is useful for monitoring platform health, availability, or operational state in automated workflows.

Practical examples include:

  • Automatically checking platform status before deploying updates.
  • Triggering alerts or notifications if a platform is down or experiencing issues.
  • Integrating platform status checks into broader infrastructure monitoring pipelines.

Properties

Name Meaning
Platform ID The unique numeric identifier of the platform whose status you want to retrieve.
Response Format The format of the API response; can be either JSON or XML.

Output

The node outputs an array of items where each item contains a json field holding the platform status data returned by the Ikoula API.

  • If the response format is JSON, the json field contains a parsed JSON object representing the platform status.
  • 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 operation.

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 authentication details are set up correctly.
  • HTTP request failures: Network issues, invalid platform IDs, or incorrect API URLs may cause request errors. Verify connectivity and parameter correctness.
  • Response parsing issues: If the response format is XML but downstream nodes expect JSON, consider setting the response format to JSON or adding XML parsing steps.
  • To continue processing other items even if one fails, enable the "Continue On Fail" option in the node settings.

Links and References

Discussion