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 integrates with the Ikoula VPS API to manage virtual private servers (VPS). It allows users to perform various operations such as starting, stopping, pausing, resuming, and retrieving status or details of VPS instances. The "Start" operation specifically initiates the startup process of a specified VPS subscription.

Common scenarios for this node include automating VPS lifecycle management within workflows, such as starting a VPS before deploying applications or services, checking VPS status before performing maintenance, or integrating VPS control into broader IT automation pipelines.

Practical example: Automatically start a VPS instance when a deployment pipeline triggers, ensuring the server is running before application deployment begins.

Properties

Name Meaning
Subscription ID The unique identifier of the VPS subscription to operate on.
Response Format The format in which the API response is returned. Options: JSON, XML.

Output

The node outputs an array of items where each item contains a json field representing the API response from the Ikoula VPS service.

  • For the "Start" operation, the output JSON typically includes confirmation or status information about the VPS startup request.
  • If the response format is JSON, the output is parsed as a JavaScript object.
  • If the response format is XML, the raw XML string is returned under the data property inside the JSON output.
  • No binary data output is produced by this node.

Example output snippet for a successful start operation (in JSON):

{
  "status": "success",
  "message": "VPS started successfully"
}

Dependencies

  • Requires an API key credential for authenticating with the Ikoula VPS API.
  • Uses RSA public key encryption to encrypt the password before sending it to the API.
  • The base URL for the API defaults to https://api.ikoula.com but can be overridden via credentials.
  • The node uses HTTP requests with appropriate headers depending on the requested response format (JSON or XML).

Troubleshooting

  • No credentials provided!
    This error occurs if the required API authentication credentials are missing. Ensure that valid API credentials are configured in n8n before executing the node.

  • HTTP request failures
    Network issues, invalid subscription IDs, or incorrect parameters may cause API call failures. Verify the subscription ID is correct and the API service is reachable.

  • Invalid response format
    If the response format is set incorrectly, parsing errors might occur. Use "JSON" unless XML is specifically needed and supported downstream.

  • Encryption issues
    The node encrypts the password using a hardcoded RSA public key. If the API changes its key or encryption method, authentication will fail. Update the node accordingly.

Links and References

Discussion