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 interacts with the Ikoula VPS API to manage VPS snapshots, specifically allowing users to list all snapshots of a virtual machine (VPS). It is useful for scenarios where you want to retrieve and monitor the available snapshots for backup, rollback, or auditing purposes.

Practical examples include:

  • Automating snapshot inventory checks before performing updates or changes on a VPS.
  • Integrating snapshot listings into monitoring dashboards.
  • Triggering workflows based on the presence or absence of certain snapshots.

Properties

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

Output

The node outputs an array of items, each containing a json field with the data returned by the Ikoula VPS API for the list of snapshots. The structure depends on the API response but typically includes details about each snapshot such as snapshot name, creation date, and other metadata.

If the response format is set to JSON, the output will be parsed JSON objects. If XML is selected, the raw XML string is returned under the data property inside the json output.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Ikoula VPS API, including an 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 endpoint (https://api.ikoula.com by default).
  • Proper configuration of the API credentials within n8n is necessary.

Troubleshooting

  • No credentials provided!
    This error occurs if the node is executed without setting up the required API credentials. Ensure that the API authentication details are correctly configured in n8n.

  • API request failures
    Common issues might include network errors, invalid subscription IDs, or incorrect response format settings. Verify the subscription ID is correct and that the API service is reachable.

  • Unexpected response format
    If the output is not as expected, check the "Response Format" property. Selecting XML returns raw XML strings, which may require additional parsing downstream.

Links and References

Discussion