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 various aspects of virtual private servers (VPS). Specifically, the "Resume" operation under the "VPS Summary" resource allows users to resume a paused VPS instance. This is useful in scenarios where a VPS has been temporarily paused to save resources or for maintenance and needs to be brought back online without a full restart.

Practical examples include:

  • Resuming a VPS after scheduled downtime.
  • Restarting services on a VPS that was paused due to resource constraints.
  • Automating VPS lifecycle management workflows where pausing and resuming are part of operational procedures.

Properties

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

Output

The node outputs the API response in the selected format (JSON or XML) within the json field of the output data. If the response is JSON, it will be parsed into an object; if XML, it will be returned as a string under the data property.

Example JSON output structure (simplified):

{
  "json": {
    // API response fields depending on the resume operation result
  }
}

No binary data output is produced by this operation.

Dependencies

  • Requires valid API 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.
  • No additional environment variables are required beyond the API credentials.

Troubleshooting

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

  • Invalid Subscription ID
    If the subscription ID does not correspond to an existing VPS service, the API may return an error. Verify the subscription ID is correct.

  • API Response Errors
    The node forwards API errors as exceptions unless "Continue On Fail" is enabled. Check the API response message for details such as permission issues or invalid parameters.

  • Incorrect Response Format
    Selecting XML format returns raw XML strings, which might require additional parsing downstream.

Links and References

This summary focuses on the "Resume" operation of the "VPS Summary" resource as requested.

Discussion