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 various aspects of virtual private servers (VPS). Specifically, for the "VPS DNS Secondary" resource and the "Modify Secondary DNS" operation, it allows users to modify an existing secondary DNS entry associated with a VPS server IP.

Typical use cases include updating DNS records for secondary DNS zones on a VPS, which is useful when DNS configurations need to be changed without affecting primary DNS settings. For example, if you want to update the DNS name linked to a secondary DNS entry on your VPS, this node operation facilitates that change via the Ikoula API.

Properties

Name Meaning
Server IP The IP address of the VPS server where the secondary DNS entry exists.
DNS ID The unique identifier of the secondary DNS entry to modify.
DNS Name The new DNS name to set for the specified secondary DNS entry.
Response Format The format in which the API response will be returned. Options: JSON, XML.

Output

The node outputs the API response in the selected format (json or xml). When JSON is selected, the output is parsed into a JavaScript object under the json field. This typically contains details about the modified secondary DNS entry or confirmation of the modification.

If XML is selected, the raw XML string is returned as the data inside the json field under a property named data.

No binary data output is produced by this operation.

Example JSON output structure (simplified):

{
  "json": {
    "id": 123,
    "dns_name": "new.dns.name",
    "status": "modified"
  }
}

Dependencies

  • Requires valid credentials for the Ikoula VPS API, including an 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 endpoints.
  • No additional external dependencies beyond standard n8n helpers and Node.js crypto module.

Troubleshooting

  • No credentials provided!
    Error thrown if the required API credentials are missing. Ensure that the node has been configured with valid Ikoula API credentials.

  • Invalid DNS ID or Server IP
    If the DNS ID or Server IP is incorrect or does not exist, the API may return an error indicating the resource was not found. Verify these inputs carefully.

  • API Response Errors
    The API might return errors related to authentication, permissions, or invalid parameters. Check the exact error message in the node output and verify credentials and input values.

  • Response Format Issues
    Selecting XML format returns raw XML data as a string. If further processing is needed, consider using JSON format or add parsing steps downstream.

Links and References


This summary focuses exclusively on the "Modify Secondary DNS" operation within the "VPS DNS Secondary" resource based on the provided source code and properties.

Discussion