Ricardoneud.com
DocumentationHelp Center
API Reference
  • Production
  • Sandbox (Coming Soon)
DocumentationHelp Center
API Reference
  • Production
  • Sandbox (Coming Soon)
Discord Community
Github
  1. Custom Domains
  • Getting Started
    • Introduction
    • Firewall
  • Custom Domains
    • Introduction
    • API
  • SDK
    • Javascript
    • PHP
    • Python
  • Products
    • Next.js Docs Template
      • Installation
        • VPS Installation
        • Pterodactyl Installation
    • Game Panels
      • Pterodactyl
        • Eggs
          • Installation
            • Next.js Egg
        • Extensions
          • Installation
            • Pterodactyl Livechat
      • Pelican
        • Eggs
          • Installation
            • Next.js Egg
    • Donate Me
      • Installation
        • VPS Installation
        • Pterodactyl Installation
    • LicenseForge
      • Installation
        • VPS Installation
        • Webhost Installation
      • API
        • Check License
    • Billing Portals
      • WHMCS
        • Extensions
          • Installation
            • Ticket Spam Checker
            • Chatwoot Livechat
    • ProbeCore
      • Introduction
      • Self Hosting
        • Installation
          • VPS Installation
          • Pterodactyl Installation
    • Other
      • Drako Bot
        • Addons
          • Installation
            • SmartResponse Addon
  1. Custom Domains

API

By default, our API is accessible on the api.ricardoneud.com domain. However, you can customize this by setting a custom domain, meaning your clients will be able to access our API on a domain that fits your organization.
Custom domains can be set by users with admin permissions. Please follow these steps in order to set a custom domain.

Why Use Custom Domains?#

Custom domains provide several key benefits:
Branded API endpoints: Replace the default api.ricardoneud.com with your own domain
Enhanced security: All traffic is automatically secured with HTTPS via SSL certificates
Professional appearance: Provide clients and developers with a fully branded experience
Automated workflow: DNS validation, SSL provisioning, verification, and renewal are handled automatically

Initiating the Custom Domain Setup#

You can access the options for setting a custom domain in your dashboard. Navigate to Dashboard → API → Custom Domains to begin the setup process.
Custom Domain Dashboard

Step 1: Add Your Domain on Ricardoneud.com#

Start by adding your domain in the Ricardoneud.com dashboard.
1.
Go to your Ricardoneud.com Dashboard → Custom Domains
2.
Enter your domain in the Add Domain field (e.g., api.yourdomain.com)
3.
Click Add Domain to register
Add Domain Interface

Step 2: Configure DNS (CNAME Setup)#

Now that you've added the domain, you need to configure DNS at your DNS provider.
Configuring DNS happens outside of Ricardoneud.com, at the DNS provider you are using for your domain.
There are two parts to this step:
1.
Configure a CNAME record
2.
Wait for the changes to take effect

Configure a CNAME Record#

The names of the fields and what to actually enter to configure the record may differ between DNS control panels, but we've covered the most common options here. If you're uncertain, verify with your DNS provider.
The type is the kind of DNS record that you want to create. Here, you need to choose CNAME.
The name or DNS entry is where you enter your subdomain. You might need to enter it in full (e.g. api.example.com) or you might just need to enter the part before your apex domain (e.g. api). If you're not sure which to use, check with your DNS provider.
The target or value or destination is where the subdomain should be pointed. You should enter api.zone-bind.com as the target value.
You might also see a field named TTL, which stands for Time To Live. It's the number of seconds that the DNS record can be cached for. If you're not sure what to set, we suggest select Auto or remain default value.
Here's an example of how a correct configuration looks in a typical DNS control panel:
FieldValue
TypeCNAME
Nameapi
Target/Valueapi.zone-bind.com
TTL1 hr
DNS Configuration Example
Note: CNAME record cannot co-exist with another record for the same name. If you already have an A record, AAAA record, TXT record, or any other type of record for your chosen subdomain, you would need to remove those first, before adding the CNAME record.
Are you using Cloudflare?
If you are configuring DNS in Cloudflare's control panel, please ensure that Cloudflare's proxying (the orange cloud, also called "Proxy status" in your domain settings) is disabled. This is for two reasons:
This option obfuscates the DNS target for your domain to the public, preventing proper DNS validation checks.
Your custom domain will already benefit from our CDN infrastructure.
Again, please turn off Cloudflare proxying to ensure that your API is served without issues.

Wait for DNS Propagation#

The short answer: you might need to wait 10 minutes ~ 48 hours for the DNS changes to take effect before the system can validate your configuration.
Remember the TTL (Time To Live) field we mentioned earlier? DNS records are cached for a period of time — which is usually a very good thing for performance reasons, because they typically don't change very often. When they do change, there is a period of time (the TTL value) where DNS cache servers need their cache to expire before they will check for any changes and behave accordingly.
In most cases, it's best to allow at least 10 minutes before the automated validation begins. Sometimes it could all update a bit more quickly, or it could take longer. It's rare for this to take longer than 48 hours.
Want to check how this process, known as propagation, is progressing? You could use a DNS lookup tool, such as our DNS Checker. Enter your full subdomain, select CNAME from the dropdown list, and press the Search button. DNS cache servers around the world will respond to let you know what their cached result is. You'll want to periodically check these results until the vast majority respond with api.zone-bind.com.
Once your DNS is configured and propagated, the domain will automatically progress through the following stages in your dashboard:
StageDescriptionDuration
DNS ValidationVerifying your CNAME record is configured2-5 minutes
SSL ProvisioningRequesting SSL certificate from Let's Encrypt5-10 minutes
SSL VerificationVerifying certificate installation and activation3-5 minutes
CompletedDomain is active and ready for productionInstant
Coming Soon: Additional SSL certificate providers including Google Trust Services and ZeroSSL will be available for enhanced reliability and redundancy.
The entire process is fully automated. Once DNS validation succeeds, SSL provisioning and verification are handled automatically without any manual intervention required.

Step 3: Automatic SSL Management#

SSL certificates are automatically requested and issued via trusted certificate authorities. Currently, we use Let's Encrypt, with Google Trust Services and ZeroSSL coming soon. Verification and renewal are fully automated; no manual intervention is required.

SSL Certificate Features#

Multiple Certificate Authorities: Certificates are currently issued via Let's Encrypt, with additional providers (Google Trust Services, ZeroSSL) coming soon for enhanced reliability
Automatic Provisioning: Certificates are issued within 5-10 minutes after DNS validation
Automatic Verification: SSL status is checked and verified (3-5 minutes)
Automatic Renewal: Certificates are renewed before expiration (typically 30 days before)
Zero Configuration: No manual certificate management required
Processing Times: The system uses deliberate timing intervals to ensure stability and prevent race conditions:
DNS Validation: 2-5 minutes
SSL Provisioning: 5-10 minutes
SSL Verification: 3-5 minutes
These intervals are designed to prevent duplicate requests and ensure reliable certificate issuance.

SSL Status Example#

DomainSSL ProviderSSL StatusAPI Endpoint
api.yourdomain.comLet's EncryptActivehttps://api.yourdomain.com
Best Practice: Ensure your domain resolves publicly for automatic SSL provisioning. All API traffic will automatically use HTTPS once SSL is active.

SSL Troubleshooting#

Automated SSL minimizes errors, but common issues include:
Domain not publicly accessible: Ensure DNS is correctly configured and propagated
Propagation delays: SSL provisioning may take a few minutes depending on DNS propagation
Conflicting DNS records: Remove any A or AAAA records that might conflict with the CNAME
If you experience persistent SSL issues, please contact support via our Contact Forum.

Step 4: Use Your Custom Domain#

Once your custom domain is active and SSL is configured, you can use it in all API requests.

Example API Requests#

Advantages#

Branded domain for client applications
Consistent and professional URL structure
Fully secured with HTTPS using industry-standard encryption
Improved trust with your API consumers

Domain Management#

Viewing Your Domains#

You can view all your custom domains in the dashboard. Each domain displays:
Domain name
Current status (Active, Pending, Failed)
SSL certificate status
SSL certificate provider
Date added
Actions (Delete, Refresh)
Domain Management Dashboard

Deleting a Domain#

Note: Deleting a custom domain will immediately stop routing traffic through that specific domain. However, the API remains fully accessible via api.ricardoneud.com and any other configured custom domains. Ensure you have updated client applications using the deleted domain before removal.
To delete a domain:
1.
Navigate to Dashboard → API → Custom Domains
2.
Click the Delete button next to the domain
3.
Confirm the deletion in the dialog

Advanced Features#

The custom domain system includes several advanced features:
Custom API Domain: Branded endpoints for your API requests
Automatic SSL Provisioning: Certificates issued instantly after DNS validation
Automatic SSL Verification: Status and expiration handled in real time
Automatic SSL Renewal: Certificates renewed without manual intervention (60 days before expiration)
DNS Validation: Fully automated with real-time completion
High Availability: Built on enterprise-grade CDN infrastructure

Notes & Best Practices#

Production Best Practices:
Always use your custom domain in production instead of api.ricardoneud.com
Verify your domain resolves publicly before adding it to your code
Monitor your dashboard for domain and SSL status updates
Test API endpoints over HTTPS to ensure proper configuration
Keep your DNS TTL values reasonable (between 300 and 3600 seconds)
Document your custom domain for your development team

Frequently Asked Questions#

Q: How long does the entire setup take?
A: Once DNS is propagated (10 minutes to 48 hours), the automated setup takes approximately 10-20 minutes total (2-5 min DNS validation + 5-10 min SSL provisioning + 3-5 min SSL verification).
Q: Which certificate authority is used?
A: Currently, SSL certificates are issued via Let's Encrypt. Additional providers including Google Trust Services and ZeroSSL are coming soon, which will be automatically selected for optimal reliability and performance.
Q: Can I use a root domain (e.g., example.com) instead of a subdomain?
A: We recommend using a subdomain (e.g., api.example.com) as CNAME records work more reliably with subdomains. Root domains can have DNS limitations.
Q: What happens if my SSL certificate expires?
A: Renewal is fully automatic and happens 20 days before expiration, ensuring continuous HTTPS availability with zero downtime.
Q: Can I use multiple custom domains?
A: Yes, you can add multiple custom domains to your account. Each will have its own SSL certificate and routing configuration. All domains work simultaneously alongside api.ricardoneud.com.
Q: Do I need to configure anything after adding the domain?
A: No. Once DNS is configured and the domain is added, everything else is automatic including SSL provisioning, verification, and renewal.
Q: What if DNS validation fails?
A: Check that your CNAME record is correctly configured and pointing to api.zone-bind.com. Use a DNS lookup tool like WhatsMyDNS to verify propagation.
Q: Is there any downtime when switching to a custom domain?
A: No. Your API remains accessible on both api.ricardoneud.com and your custom domain. The default domain always remains available regardless of custom domain configuration.
Q: Can I use both the default domain and custom domain simultaneously?
A: Yes. Both api.ricardoneud.com and your custom domain(s) work simultaneously. You can use whichever endpoint suits your needs.
Q: What happens if I delete my custom domain?
A: Deleting a custom domain only removes that specific domain. Your API continues to work normally on api.ricardoneud.com and any other custom domains you have configured.

Troubleshooting#

If you encounter issues during setup:
1.
Verify DNS Configuration: Use our DNS Checker to check CNAME propagation
2.
Check Domain Status: Review the status in your dashboard for specific error messages
3.
Wait for Propagation: DNS changes can take up to 48 hours
4.
Disable Cloudflare Proxy: If using Cloudflare, ensure the proxy (orange cloud) is disabled
5.
Remove Conflicting Records: Ensure no A, AAAA, or other records exist for the same subdomain
If problems persist, please contact us via our Contact Forum with:
Your custom domain name
Current domain status from your dashboard
Screenshots of your DNS configuration
Any error messages you're seeing
Modified at 2025-10-26 15:11:38
Previous
Introduction
Next
Javascript
Built with