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 and retrieve information about virtual private servers (VPS). Specifically, the "Get Service Details" operation under the "VPS Summary" resource fetches detailed information about a specific VPS service by its subscription ID. This is useful for users who want to programmatically access comprehensive data about their VPS instances, such as configuration details, status, or billing info.

Practical examples include:

  • Automatically retrieving VPS details to monitor server configurations.
  • Integrating VPS service data into dashboards or reporting tools.
  • Triggering workflows based on specific VPS attributes or statuses.

Properties

Name Meaning
Subscription ID The unique identifier of the VPS subscription for which to get detailed service details.
Response Format The format in which the API response should be returned. Options: JSON, XML.

Output

The output is an array of items where each item contains a json field holding the API response data. For the "Get Service Details" operation, the json object includes detailed information about the specified VPS service. If the response format is JSON, this will be a parsed JSON object; if XML is chosen, the raw XML string is provided under a data property.

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 the Ikoula API endpoint (default: https://api.ikoula.com).
  • The password is encrypted using RSA public key encryption before sending.
  • Proper n8n credentials setup with email, password, and optionally a custom API URL is necessary.

Troubleshooting

  • No credentials provided!
    This error occurs if the required API credentials are missing. Ensure that valid credentials are configured in n8n before running the node.

  • Invalid Subscription ID
    If the subscription ID does not correspond to an existing VPS service, the API may return an error or empty response. Verify the subscription ID is correct.

  • API Response Format Issues
    Selecting XML format returns raw XML strings which might require additional parsing downstream. Choose JSON format for easier integration unless XML is specifically needed.

  • Network or Authentication Errors
    Check network connectivity and ensure the API credentials (email, password) are valid and have sufficient permissions.

Links and References

Discussion