Ikoula VPS API icon

Ikoula VPS API

Interact with Ikoula VPS API. Developed by Ascenzia - www.ascenzia.fr
Join our community

Actions25

Overview

This node interacts with the Ikoula VPS API to manage virtual private servers (VPS). Specifically, for the VPS Reset resource and the List Available OS operation, it retrieves a list of all operating systems available for resetting a VPS. This is useful when you want to see which OS options you can install on your VPS before performing a reset.

Common scenarios include:

  • Preparing to reset a VPS to a new operating system by first listing available OS options.
  • Automating VPS management workflows where OS selection is dynamic.
  • Integrating VPS OS management into broader infrastructure automation pipelines.

Example: You have a VPS subscription and want to programmatically fetch all OS images you can install on that VPS before triggering a reset.

Properties

Name Meaning
Subscription ID The unique identifier of the VPS subscription for which to list available operating systems.
Response Format The format in which the API response should be returned. Options: JSON, XML.

Output

The output is an array of JSON objects representing the API response from the Ikoula VPS service. For the "List Available OS" operation, the json field contains the data listing all operating systems available for reset on the specified VPS subscription.

If the response format is set to JSON, the output will be parsed JSON data; if XML is selected, the raw XML string is returned inside the data property of the JSON output.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Ikoula VPS API, including email, password, and optionally a custom API URL.
  • The node uses RSA public key encryption to encrypt the password before sending requests.
  • The API endpoint defaults to https://api.ikoula.com unless overridden in credentials.
  • Proper API authentication credentials must be configured in n8n prior to using this node.

Troubleshooting

  • No credentials provided!
    Error thrown if the required API credentials are missing or not configured correctly. Ensure you have set up the necessary API authentication details in n8n.

  • API request failures
    Could occur due to invalid subscription IDs, network issues, or incorrect parameters. Verify the subscription ID is correct and the API service is reachable.

  • Unexpected response format
    If the response format does not match expectations, check the "Response Format" property and ensure the API supports the requested format.

  • Continue On Fail behavior
    If enabled, errors during execution will be captured in the output as error messages instead of stopping the workflow.

Links and References

Discussion