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 server (VPS) snapshots. Specifically, the "Create Snapshot" operation allows users to create a new snapshot of a specified VPS subscription. Snapshots capture the current state of a VPS, enabling easy backup and recovery.

Common scenarios for this node include:

  • Automating backups before making system changes or updates.
  • Creating restore points to quickly revert a VPS to a previous state.
  • Integrating snapshot creation into deployment or maintenance workflows.

For example, a user can trigger this node to create a snapshot right before applying software updates on their VPS, ensuring they can roll back if something goes wrong.

Properties

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

Output

The node outputs the API response in the json field of each item. The structure depends on the chosen response format:

  • If JSON format is selected, the output is a parsed JSON object representing the API's response to the snapshot creation request.
  • If XML format is selected, the output is a string containing the raw XML response from the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ikoula VPS API.
  • The node uses RSA public key encryption to encrypt the password before sending requests.
  • The base URL for the API defaults to https://api.ikoula.com but can be overridden via credentials.
  • Proper network access to the Ikoula API endpoint is necessary.

Troubleshooting

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

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

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

  • Encryption errors
    The node encrypts the password using a fixed RSA public key. If this key becomes outdated or incompatible, authentication will fail.

Links and References

Discussion