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 various aspects of virtual private servers (VPS). Specifically, for the VPS Security Scan resource and the Request Security Scan operation, it allows users to request a new security scan on a specified server IP address. Users can optionally schedule the scan for a future date.

This functionality is beneficial for system administrators or security teams who want to automate vulnerability scanning of their VPS instances directly within their workflow automation platform. For example, after deploying a new application or patch, a user might trigger a security scan to verify that no vulnerabilities are present.

Properties

Name Meaning
Server IP The IP address of the server on which to perform the security scan.
Scan Date Optional. The date to schedule the security scan. If left empty, the scan runs immediately.
Response Format The format in which the API response will be returned. Options: JSON, XML.

Output

The node outputs the API response from the security scan request under the json field. The structure depends on the chosen response format:

  • If JSON is selected, the output will be a parsed JSON object containing details about the requested security scan, such as scan ID, status, scheduling information, etc.
  • If XML is selected, the output will contain the raw XML response as a string under the data property inside the json output.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ikoula VPS API.
  • The node uses RSA public key encryption to encrypt the password before sending requests.
  • The base URL for the API defaults to https://api.ikoula.com but can be overridden via credentials.
  • Proper network access to the Ikoula API endpoint is necessary.

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 authentication token in the node's credentials.

  • Invalid Server IP or Subscription ID
    If the server IP or subscription ID parameters are incorrect or missing, the API may return errors or fail to locate the VPS instance. Double-check these inputs.

  • Scan scheduling issues
    If providing a Scan Date, ensure it is in the correct format expected by the API. Invalid dates may cause the request to fail.

  • API response format errors
    Selecting XML format returns raw XML strings; downstream nodes expecting JSON may fail. Choose JSON format unless XML is specifically needed.

  • Network or API errors
    Network connectivity problems or API service outages will cause HTTP request failures. Check your internet connection and Ikoula service status.

Links and References

Discussion