Namecheap icon

Namecheap

Consume Namecheap API

Overview

This node integrates with the Namecheap API to manage DNS records for domains. Specifically, the "Get Hosts" operation under the "DNS Record" resource retrieves the DNS host records associated with a specified domain name. This is useful for scenarios where you need to programmatically fetch and review DNS settings, such as verifying current DNS entries before making changes or auditing domain configurations.

Practical examples include:

  • Automatically fetching DNS records to sync with another system.
  • Checking DNS hosts before updating or migrating domain settings.
  • Monitoring DNS records for troubleshooting or reporting purposes.

Properties

Name Meaning
Domain Name The domain to manage DNS records for. It expects a string representing the domain (e.g., "example.com").

Output

The output JSON contains two main fields:

  • success: A boolean indicating whether the operation was successful.
  • data: Contains the retrieved DNS host records for the specified domain. The exact structure of this data depends on the Namecheap API response but typically includes details like host names, record types, values, TTLs, etc.

Example output structure:

{
  "success": true,
  "data": {
    // DNS host records details here
  }
}

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Namecheap API via an API key credential configured in n8n.
  • The node depends on the internal Namecheap API client classes bundled within the node implementation.
  • Network access to the Namecheap API endpoints is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing domain name input will cause errors.
    • API authentication failures due to incorrect or expired credentials.
    • Network connectivity problems preventing access to the Namecheap API.
    • Using an unsupported operation or resource combination will throw an error.
  • Error messages:

    • "The operation "getHosts" is not known for resource "dns"!" indicates a misconfiguration of the operation or resource parameters.
    • Errors related to API calls will typically include messages from the Namecheap API, such as authentication errors or invalid domain errors.
  • Resolution tips:

    • Ensure the domain name is correctly provided and valid.
    • Verify that the API key credential is properly set up and has sufficient permissions.
    • Check network connectivity and firewall settings.
    • Confirm that the selected resource and operation are supported by the node.

Links and References

Discussion