Ikoula VPS APIInstall

Overview

This node integrates with the Ikoula VPS API to manage various aspects of virtual private servers (VPS). Specifically, for the VPS Security Scan resource and the Get Scan Results operation, it retrieves the results of a previously requested security scan on a VPS server identified by its IP address and a scan ID.

Typical use cases include:

• Automating security monitoring workflows by fetching scan results programmatically.
• Integrating VPS security status into dashboards or alerting systems.
• Periodically checking scan outcomes after initiating scans to track vulnerabilities or threats.

For example, after requesting a security scan on a VPS, you can use this node operation to fetch the detailed scan report in JSON or XML format for further processing or notification.

Properties

Output

The node outputs an array of items, each containing a json field with the scan results data.

• If the response format is JSON, the json field contains the parsed JSON object representing the scan results.
• 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 operation.

Example JSON output structure (simplified):

{
  "scanId": 12345,
  "serverIp": "192.0.2.1",
  "status": "completed",
  "vulnerabilities": [
    {
      "name": "Open Port",
      "severity": "medium",
      "description": "Port 22 is open"
    }
  ],
  "scanDate": "2024-06-01T12:00:00Z"
}

(Note: Actual fields depend on the Ikoula API response.)

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 sending.
• The node makes HTTP requests to the Ikoula API endpoints.
• No additional external dependencies beyond standard n8n helpers and Node.js crypto module.

Troubleshooting

• No credentials provided!
  This error occurs if the node is executed without setting up the required API authentication credentials. Ensure that the Ikoula API credentials are configured correctly in n8n.

• HTTP request failures
  Network issues, invalid parameters (e.g., wrong server IP or scan ID), or API service downtime may cause errors. Verify input values and network connectivity.

• Invalid scan ID or server IP
  If the scan ID or server IP does not correspond to an existing scan, the API may return an error or empty result. Double-check these inputs.

• Response format issues
  Selecting XML format returns raw XML as a string inside the JSON output. Downstream nodes expecting JSON should handle this accordingly.

Links and References

• Ikoula VPS API Documentation (general reference, actual endpoint details may vary)
• n8n HTTP Request Node Documentation (for understanding HTTP request handling)

If you need summaries for other resources or operations, please provide their names.