Namecheap icon

Namecheap

Consume Namecheap API

Overview

This node integrates with the Namecheap API to manage domain-related operations. Specifically, the "Get Registrar Lock" operation under the "Domain" resource retrieves the current registrar lock status of a specified domain name. Registrar lock is a security feature that prevents unauthorized domain transfers.

Common scenarios for this operation include:

  • Checking if a domain is locked before attempting a transfer.
  • Automating domain management workflows where domain lock status needs verification.
  • Monitoring domains to ensure they remain protected against unauthorized changes.

Example use case: Before initiating a domain transfer to another registrar, you can use this operation to confirm that the domain's registrar lock is disabled, as transfers typically require the lock to be off.

Properties

Name Meaning
Domain Name The domain name to operate on (e.g., "example.com"). This is the domain whose registrar lock status will be retrieved.

Output

The output JSON contains two main fields:

  • success: A boolean indicating whether the operation was successful.
  • data: Contains the response data from the Namecheap API about the domain's registrar lock status. This typically includes information such as whether the lock is enabled or disabled.

Example output structure:

{
  "success": true,
  "data": {
    "RegistrarLock": "true"
  }
}

No binary data is output by this operation.

Dependencies

  • Requires an active connection to the Namecheap API.
  • Requires an API authentication credential configured in n8n to authorize requests.
  • The node depends on the internal Domain class implementation which handles communication with the Namecheap API for domain operations.

Troubleshooting

  • Common issues:

    • Invalid or missing domain name input will cause errors.
    • API authentication failures due to incorrect or expired credentials.
    • Network connectivity issues preventing access to the Namecheap API.
  • Error messages:

    • "The operation "getRegistrarLock" is not known for resource "domain"!" — indicates a misconfiguration or typo in the operation name.
    • API errors returned from Namecheap (e.g., domain not found, permission denied) will be surfaced in the error message.
  • Resolutions:

    • Ensure the domain name is correctly formatted and exists.
    • Verify that the API key credential is valid and has necessary permissions.
    • Check network connectivity and firewall settings.

Links and References

Discussion