Ikoula VPS API icon

Ikoula VPS API

Interact with Ikoula VPS API. Developed by Ascenzia - www.ascenzia.fr

Overview

This node integrates with the Ikoula VPS API to manage and retrieve information about virtual private servers (VPS). Specifically, the "List Services" operation under the "VPS Summary" resource fetches a list of all VPS client services associated with the user's account. This is useful for users who want to programmatically obtain an overview of their VPS subscriptions and services without manually logging into the provider's dashboard.

Practical examples include:

  • Automatically retrieving all active VPS services to monitor usage or status.
  • Feeding VPS service data into dashboards or reports.
  • Triggering workflows based on the presence or absence of certain VPS services.

Properties

Name Meaning
Subscription ID The VPS subscription ID (number). Required for operations other than "List Services".
Response Format The format of the API response. Options: JSON or XML. Default is JSON.

Note: For the "List Services" operation specifically, only the "Response Format" property is relevant since it lists all services without needing a subscription ID input.

Output

The output is an array of items where each item contains a json field representing the API response data.

  • When the response format is JSON, the json field contains parsed JSON data representing the list of VPS services.
  • When the response format is XML, the raw XML string is returned inside the json.data field as a string.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Ikoula VPS API, including 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 n8n credential configuration with the necessary API authentication details is mandatory.

Troubleshooting

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

  • HTTP request failures
    Could be due to network issues, invalid subscription IDs, or incorrect API URLs. Verify connectivity and parameter correctness.

  • Invalid response format
    If the chosen response format is XML but downstream nodes expect JSON, parsing errors may occur. Choose the appropriate format based on your workflow needs.

  • Continue On Fail
    If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References


This summary focuses exclusively on the "List Services" operation of the "VPS Summary" resource as requested.

Discussion