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 manage and retrieve information about platforms hosted on Ikoula. Specifically, the "List Platform Servers" operation fetches a list of servers associated with a specified platform ID. This is useful for users who want to programmatically monitor or manage their server infrastructure within the Ikoula cloud environment.

Practical examples include:

  • Automatically retrieving all servers under a platform to perform further automation or monitoring.
  • Integrating server lists into dashboards or reporting tools.
  • Triggering workflows based on server inventory changes.

Properties

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

Output

The output is an array of items where each item contains a json field holding the API response data. For the "List Platform Servers" operation, this JSON contains the details of servers associated with the specified platform.

If the response format is set to JSON, the output will be parsed JSON objects representing server data. 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 and password.
  • The password is encrypted using RSA public key encryption before being sent.
  • The node makes HTTP GET requests to the Ikoula API endpoint (default: https://api.ikoula.com).
  • The user must configure the node with appropriate API credentials.

Troubleshooting

  • No credentials provided!
    Error thrown if the node is executed without valid Ikoula API credentials configured. Ensure credentials are set up correctly.

  • API request failures
    Network issues, invalid platform IDs, or incorrect credentials can cause HTTP request errors. Verify platform ID correctness and credential validity.

  • Response format issues
    Choosing XML format returns raw XML as a string; downstream nodes expecting JSON may fail. Use JSON format unless XML is specifically needed.

  • Continue On Fail behavior
    If enabled, the node will continue processing other items even if one fails, returning error messages in the output JSON.

Links and References

Discussion