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 "VPS Reset" resource with the "Reset Virtual Machine" operation allows users to reset a VPS instance by reinstalling it with a new operating system. This is useful when you want to quickly reinitialize your VPS environment, for example, to switch to a different OS or recover from a corrupted system state.

Practical scenarios include:

  • Reinstalling a VPS with a fresh OS after testing or development.
  • Changing the operating system to meet new software requirements.
  • Recovering a VPS that has become unstable or compromised.

Properties

Name Meaning
Operating System ID The identifier of the operating system to install on the VPS during the reset process.
Response Format The format in which the API response will be returned. Options: JSON, XML.

Output

The output contains a json field representing the API response from the VPS reset request. The structure depends on the chosen response format:

  • If JSON is selected, the output is a parsed JSON object containing details about the reset operation status.
  • If XML is selected, the output is a raw XML string wrapped inside a JSON object under the data key.

No binary data 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.
  • The node performs HTTP requests to the Ikoula API endpoints.

Troubleshooting

  • No credentials provided!
    This error occurs if the required API authentication credentials are missing. Ensure you have configured the API key and related credentials properly in n8n.

  • Invalid Operating System ID
    If the OS ID provided does not match any available OS on the server, the API may return an error. Verify the OS ID by listing available operating systems first.

  • API Response Errors
    Errors from the API (e.g., network issues, invalid parameters) will be thrown as exceptions. Use the "Continue On Fail" option in n8n to handle these gracefully.

  • Incorrect Response Format
    Selecting XML format returns raw XML data; ensure downstream nodes can handle this format or choose JSON for easier parsing.

Links and References

If you need further details on other operations or resources, feel free to ask!

Discussion