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) and related resources. Specifically, the "Shutdown (Software)" operation under the "VPS Summary" resource allows users to gracefully stop a virtual machine via software commands.

Common scenarios for this node include automating VPS lifecycle management tasks such as starting, stopping, pausing, resuming, or shutting down virtual machines programmatically. For example, you might use it to schedule automatic shutdowns of VPS instances during off-hours to save costs or integrate VPS control into broader IT workflows.

Practical example:

  • Automatically shut down a VPS after completing a batch job to reduce running costs.
  • Integrate VPS status checks and shutdown commands into monitoring dashboards or alerting systems.

Properties

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

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains a json field with the API response data:

  • If the response format is JSON, the json field contains the parsed JSON object from the API.
  • 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 node.

Dependencies

  • Requires valid credentials for the Ikoula VPS 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 requests to the Ikoula API endpoints over HTTPS.
  • No additional external dependencies beyond standard n8n helpers and Node.js crypto module.

Troubleshooting

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

  • API request failures
    Network issues, invalid subscription IDs, or incorrect parameters may cause API errors. Verify that the subscription ID exists and that your API credentials have sufficient permissions.

  • Response format issues
    If you select XML as the response format, downstream nodes expecting JSON may fail. Use JSON format unless you specifically need XML.

  • Encryption errors
    The node encrypts the password with a fixed RSA public key. If the API changes its key or encryption method, authentication will fail. Check for updates to the node or API documentation.

Links and References

Discussion