Namecheap icon

Namecheap

Consume Namecheap API
Join our community

Actions28

Overview

The node integrates with the Namecheap API to manage SSL certificates. Specifically, the "Get List" operation under the "SSL" resource retrieves a list of SSL certificates associated with the user's account. This operation is useful for users who want to view and filter their SSL certificates based on status (active, expired, or new orders), search by domain name, paginate through results, and sort them by purchase date, expiry date, or host name.

Practical examples include:

  • Automatically fetching all active SSL certificates to monitor their expiry dates.
  • Searching for certificates related to a specific domain.
  • Paginating through large numbers of certificates to display manageable chunks in dashboards or reports.
  • Sorting certificates to prioritize renewals or audits.

Properties

Name Meaning
Additional Fields A collection of optional parameters to refine the list query:
- List Type Type of certificates to list. Options: Active, Expired, New Order
- Search Term Search certificates by domain name (string)
- Page Page number of results (number)
- Page Size Number of results per page (number)
- Sort By Field to sort certificates by. Options: Purchase Date, Expiry Date, Host Name

Output

The output JSON contains two main fields:

  • success: A boolean indicating whether the API call was successful.
  • data: The actual response data from the Namecheap API for the requested SSL certificates list. This typically includes an array of certificate objects with details such as domain names, statuses, purchase and expiry dates, etc.

No binary data output is indicated for this operation.

Example output structure (simplified):

{
  "success": true,
  "data": [
    {
      "CertificateID": "12345",
      "DomainName": "example.com",
      "Status": "Active",
      "PurchaseDate": "2023-01-01",
      "ExpiryDate": "2024-01-01",
      ...
    },
    ...
  ]
}

Dependencies

  • Requires an active connection to the Namecheap API via an API key credential configured in n8n.
  • The node depends on the internal Ssl class implementation that handles communication with the SSL-related endpoints of the Namecheap API.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Requesting pages beyond available results may return empty data arrays.
    • Using unsupported values for "List Type" or "Sort By" could result in errors or unexpected results.
  • Error messages:
    • "The operation "getList" is not known for resource "ssl"!" indicates a misconfiguration of the operation parameter.
    • API errors returned from Namecheap (e.g., rate limits, invalid parameters) will be surfaced in the error message field.
  • Resolution tips:
    • Verify API credentials are correctly set up.
    • Use valid options for all input properties.
    • Handle pagination carefully to avoid requesting non-existent pages.
    • Enable "Continue On Fail" in the node settings to allow processing multiple items even if some fail.

Links and References

Discussion