Resolve issuesDocumenting an API

I’m having trouble adding a custom domain

View as Markdown

Custom domain problems usually occur because of incorrect setup. Be sure to review the custom domain setup documentation if you haven’t done so yet. If issues persist, continue reading.

You are experiencing one of the following issues

How to unblock yourself

HTTP 404 Error when visiting your custom domain

The error usually occurs if no collection is published on your custom domain or if the collection linked to the documentation has been deleted.

Publishing a collection on the custom domain will fix the issue.

Invalid or incorrect certificate error

This indicates an incorrect setup, usually because the TXT and CNAME records are configured on the wrong domains. To resolve the issue:

  • Verify the DNS records to ensure they are still correctly configured.

  • Wait for the DNS propagation to take effect.

  • Ensure the TXT record is configured on your root domain.

  • Note: If you’re setting up a custom domain like sub-domain.my-domain.com , the TXT record needs to be configured on my-domain.com.

  • Ensure the CNAME record is configured on the sub-domain.

  • Note: If you’re setting up a custom domain like sub-domain.my-domain.com, the CNAME record must be configured on the sub-domain.

Hostname not found / Hostname cannot be resolved errors

This usually indicates the DNS changes have not yet propagated. Your DNS settings may take up to 24 hours to take effect.

  • Check whatsmydns.net to see if the DNS records have been updated.
  • Use command-line DNS tools like dig or nslookup to verify that DNS records are correctly configured and have propagated.

Have more questions? Submit a request