Namecheap icon

Namecheap

Consume Namecheap API
Join our community

Actions28

Overview

This node integrates with the Namecheap API to manage domain-related operations. Specifically, for the Domain - Get List operation, it retrieves a paginated list of domains associated with the user's account. This is useful for users who want to programmatically access and manage their domain portfolio, such as listing all domains they own, sorting them by name or expiration date, and handling large numbers of domains efficiently through pagination.

Practical examples include:

  • Displaying all registered domains in an automated report.
  • Syncing domain lists with other systems or dashboards.
  • Filtering and sorting domains to identify those nearing expiration for renewal reminders.

Properties

Name Meaning
Additional Fields Collection of optional parameters to customize the domain list retrieval:
- Page Size Number of domains to return per page (default 20).
- Page Page number of the results to retrieve (default 1).
- Sort By Field to sort the domains by. Options are:
- Name (alphabetical ascending)
- Name Descending
- Expiration (ascending by expiration date)
- Expiration Descending

Output

The output is an array of JSON objects, each representing the result of the domain list retrieval for an input item. Each object has the structure:

{
  "success": true,
  "data": <domainListData>
}
  • success: Boolean indicating if the operation succeeded.
  • data: Contains the actual list of domains returned by the API call, including details such as domain names, expiration dates, and other metadata as provided by Namecheap.

If the operation fails and "Continue On Fail" is enabled, the output will contain:

{
  "success": false,
  "error": "<error message>"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Namecheap API via an API key credential configured in n8n.
  • The node depends on the Namecheap API being accessible and the credentials having sufficient permissions to list domains.
  • No additional external services or environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Invalid or expired API credentials will cause authentication failures.
    • Requesting pages beyond the available range may return empty results.
    • Network connectivity issues can prevent successful API calls.

  • Error Messages:

    • "The operation "getList" is not known for resource "domain"!" — indicates a misconfiguration of the operation parameter.
    • "The resource "domain" is not known!" — indicates an invalid resource selection.
    • API errors from Namecheap (e.g., rate limits, permission denied) will be surfaced in the error message field.

  • Resolutions:

    • Verify API credentials and permissions.
    • Adjust pagination parameters to valid ranges.
    • Ensure stable network connectivity.
    • Enable "Continue On Fail" to handle partial failures gracefully.

Links and References

Discussion