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 and retrieve information about virtual private servers (VPS). Specifically, the "Get Status" operation under the "VPS Summary" resource fetches the current status of a specified VPS instance. This is useful for monitoring the health and operational state of your VPS without logging into the server directly.

Practical examples include:

  • Automatically checking if a VPS is running or stopped before performing maintenance tasks.
  • Integrating VPS status checks into larger workflows that depend on server availability.
  • Alerting or triggering actions based on VPS status changes.

Properties

Name Meaning
Subscription ID The unique identifier of the VPS subscription whose status you want to retrieve.
Response Format The format in which the API response should be returned. Options: JSON, XML.

Output

The output contains a json field representing the API response with the VPS status details. If the response format is JSON, this will be a parsed object; if XML is chosen, the raw XML string is provided under the data property inside the JSON wrapper.

The structure typically includes information such as the VPS operational state, uptime, resource usage, and other status indicators as provided by the Ikoula VPS API.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authentication with the Ikoula VPS API.
  • The node uses RSA public key encryption to securely transmit the password.
  • The base URL defaults to https://api.ikoula.com but can be overridden via credentials.
  • Proper configuration of the API credentials within n8n is necessary for successful requests.

Troubleshooting

  • No credentials provided!
    Error thrown if the required API credentials are missing. Ensure that valid credentials are configured in n8n.

  • HTTP request failures
    Network issues, invalid subscription IDs, or incorrect parameters may cause HTTP errors. Verify the subscription ID and network connectivity.

  • Invalid response format
    Selecting XML format returns raw XML data wrapped in JSON. Make sure downstream nodes can handle the chosen format.

  • Encryption errors
    The password is encrypted using a fixed RSA public key. If the encryption fails, check for environment compatibility or updates in the API security requirements.

Links and References

Discussion