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 "Pause" operation under the "VPS Summary" resource allows users to pause a running VPS instance. Pausing a VPS can be useful in scenarios where you want to temporarily halt the server without fully stopping or shutting it down, for example, during maintenance windows or when you want to save resources without losing the current state.

Practical example:

  • A user wants to pause their VPS before performing system updates to ensure no processes are interrupted unexpectedly.
  • Temporarily pausing a VPS during off-peak hours to reduce costs or resource usage.

Properties

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

Output

The node outputs the API response in the selected format (JSON or XML) inside the json field of the output data. The structure depends on the API's response but generally contains information about the success or failure of the pause request and any relevant details from the VPS service.

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 the Ikoula public RSA key 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 configuration of the API credentials (email, password, API URL) is necessary.

Troubleshooting

  • No credentials provided!
    This error occurs if the node is executed without valid API credentials configured. Ensure that the required API authentication token or credentials 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 API might return errors related to permissions, invalid parameters, or service state (e.g., trying to pause a VPS that is already paused). Check the API response message for details.

  • Network or Connectivity Issues
    Ensure that the n8n instance has network access to the Ikoula API endpoint.

Links and References

Discussion