Ikoula Plesk Managed APIInstall

Overview

This node interacts with the Ikoula Plesk Managed API to manage Plesk hosting services. It allows users to retrieve details about specific Plesk managed service subscriptions or list all available Plesk managed services under their account.

Common scenarios where this node is beneficial include:

• Automating retrieval of subscription details for monitoring or reporting.
• Integrating Plesk service data into workflows for provisioning, auditing, or customer support.
• Fetching a list of all Plesk managed services to synchronize with other systems.

For example, a user can input a Subscription ID to get detailed information about that particular Plesk service, such as its status, configuration, and usage metrics, in either JSON or XML format.

Properties

Output

The node outputs an array of items, each containing a json field with the API response data:

• If the response format is JSON, the json field contains the parsed JSON object representing the service details or list of services.
• If the response format is XML, the json field contains the raw XML string under a data property.

No binary data output is produced by this node.

Example JSON output snippet when requesting service details in JSON format:

{
  "id": 12345,
  "name": "My Plesk Service",
  "status": "active",
  "plan": "Standard",
  ...
}

If XML format is selected, the output will be:

{
  "data": "<service><id>12345</id><name>My Plesk Service</name>...</service>"
}

Dependencies

• Requires an API key credential with email, password, and API URL for authentication against the Ikoula Plesk Managed API.
• Uses RSA public key encryption to encrypt the password before sending it to the API.
• The API endpoint defaults to https://api.ikoula.com if not specified in credentials.
• Requires network access to the Ikoula API endpoint.

Troubleshooting

• No credentials provided!
  This error occurs if the node is executed without valid API credentials configured. Ensure you have set up the required API key credential with email, password, and optionally the API URL.

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

• API response errors
  Errors from the API (e.g., authentication failure, rate limits) will be thrown by the node. Check your credentials and API usage limits.

• Response format issues
  Selecting XML format returns raw XML as a string. Downstream nodes expecting JSON must handle parsing accordingly.

• Encryption issues
  The password is encrypted using a hardcoded RSA public key. If the API changes its key, authentication will fail until updated.

Links and References

• Ikoula Plesk Managed API Documentation (example placeholder, replace with actual link if available)
• Plesk Hosting Services Overview
• n8n HTTP Request Node Documentation (for understanding underlying HTTP requests)