Ikoula NDD API
Actions4
Overview
This node integrates with the Ikoula NDD API to manage domain name services, specifically focusing on DNS registrations used for certbot validation. It allows users to add or delete DNS TXT records required by certbot to verify domain ownership during SSL certificate issuance. Additionally, it can retrieve account details and list all NDD accounts associated with the user.
Common scenarios include automating the DNS challenge process for Let's Encrypt certificates using certbot, managing multiple domain subscriptions, and querying account information programmatically within n8n workflows.
Practical example:
- Automatically add a DNS TXT record for certbot validation when requesting a new SSL certificate.
- Remove the DNS TXT record after validation is complete to keep DNS clean.
- Retrieve subscription details to audit or monitor domain services.
Properties
| Name | Meaning |
|---|---|
| Certbot Domain | The domain name for which the certbot DNS registration (TXT record) will be added or deleted. |
| Certbot Validation | The validation string that certbot requires to be set as a DNS TXT record for domain verification. |
| Response Format | The format of the API response; options are JSON or XML. |
Output
The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the API response data under the json field.
- For successful operations, the
jsonfield contains the parsed response from the Ikoula NDD API, either as a JSON object or a string wrapped in adataproperty if the response is raw text. - In case of errors (if "Continue On Fail" is enabled), the output includes an
errorproperty with the error message.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authentication with the Ikoula NDD API, including email and password.
- Uses RSA public key encryption to encrypt the password before sending it to the API.
- The base URL defaults to
https://api.ikoula.combut can be overridden via credentials. - Requires network access to the Ikoula API endpoints.
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 or key in n8n credentials.
- HTTP request failures: Network issues, invalid credentials, or incorrect parameters may cause HTTP errors. Verify API keys, endpoint URLs, and parameter correctness.
- Invalid domain or validation strings: When adding or deleting DNS registrations, ensure the domain and validation strings are accurate and correspond to certbot requirements.
- Response format issues: If XML responses are selected, downstream nodes expecting JSON might fail. Choose the response format according to your workflow needs.
Links and References
- Ikoula NDD API Documentation (general reference for API capabilities)
- Certbot DNS Challenge Documentation (for understanding DNS validation process)
This summary covers the Add DNS Registration operation within the NDD resource, describing its inputs, outputs, and usage context based on static analysis of the provided source code and property definitions.