Custom Domain

Learn how to set a custom domain for your API documentation.

By default, your documentation are accessible on a [subdomain].apidog.io domain. However, you can customize this by setting a custom domain, meaning your audience will be able to access your documentation on a domain that fits your organization.

tip

Custom domains can be set by users with owner or admin rights. Please follow these steps in order to set a custom domain:

1. Initiating the custom domain setup
2. Configuring DNS CNAME(canonical name)
3. Configuring CDN or your own reverse proxy server

1. Initiating the Custom Domain Setup

You can access the options for setting a custom domain for a project in the project's Share module. Simply click on the Share Docs menu in the sidebar, and then navigate to the Publish settings page in the secondary menu.

You will see a section titled Custom Domain. Click on the Edit button to initiate the custom domain setup.

There is two types of options for setting a custom domain:

1. DNS CNAME: This is the recommended option. It is the easiest to setup and maintain. It is also the most flexible option, as it allows you to set a custom domain for a subdomain or a root domain.
2. Reverse Proxy: This option is more advanced and requires you to use Content Delivery Network (CDN) or setup a reverse proxy on your own server. It is recommended for users who are familiar with these technologies.

2. Configuring DNS CNAME

tip

This is only applicable if you have selected the DNS CNAME option in the previous step.

Configuring DNS happens outside of Apidog, at the DNS provider you are using for your domain.

There are three 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. docs.example.com) or you might just need to enter the part before your apex domain (e.g. docs). 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 see the value for this in the Publish settings in Apidog when you choose the DNS CNAME option. It will look something like {projectId}.apidog.io. You should enter this value in full (e.g. 12345678.apidog.io).
• 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 Cloudflare’s control panel:

A properly configured custom domain in Cloudflare’s control panel

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 Apidog from properly running routine checks on your custom domain.
• Your custom domain will already benefit from CDN.

Again, please turn off Cloudflare proxying to ensure that your documentation is served without issues.

Wait For the Changes to Take Effect

---

The short answer: you might need to wait 10 minutes ~ 48 hours for the DNS changes to take effect before moving onto the next step.

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 moving onto the next and final step. 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 WhatsMyDNS. 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 your assigned CNAME value.

Once DNS propagation has completed, you can move onto the last step: Custom Domain.

3. Configuring CDN or Your Own Reverse Proxy Server

tip

This is only applicable if you have selected the Reverse Proxy option in the previous step.

Configure AWS CloudFront as Reverse Proxy

You can utilize the CDN service provided by cloud vendors like AWS CloudFront, Cloudflare Enterprise to set it up as your own reverse proxy server.

In the following example, we will configure AWS CloudFront as Reverse Proxy.

1. Log in to AWS, and navigate to CloudFront. Click Create Distribution.
2. Configure your distribution settings. Here are the values you'll need to change.

Settings	Value
Origin Domain Name	Set to {projectId}.apidog.io
Name	A description for the origin. This value lets you distinguish between multiple origins in the same distribution and therefore must be unique.
Origin Protocol Policy	Set to HTTP Only
Alternate Domain Names (CNAMEs)	Set to your custom domain name (the same one your configured in the Publish settings during the custom domain setup)
SSL Certificate	Set to the SSL Certificate for your custom domain stored in AWS Certificate Manager (ACM).

3. Provide information on the Origin Custom Headers (the Header Name and Value fields appear only after you've provided an Origin Domain Name)

Header Name	Value
X-Apidog-Project-ID	Set to {projectId}

tip

You can find the projectId value in the Apidog project settings.

4. Configure the Default Cache Behavior Settings. Here are the values you'll need to change.

Setting	Value
Viewer Protocol Policy	Select Redirect HTTP to HTTPS
Allowed HTTP Methods	Select GET, HEAD, OPTIONS, PUT, POST, PATCH, DELETE.
Cache and origin request settings	Select Use legacy cache settings. Select All for Headers, Query strings and Cookies

5. Do not enable AWS Web Application Firewall (WAF).
6. Click Create distribution at bottom of the page. You'll see your newly-created distribution in your CloudFront Distributions list. Note that the Status will reflect In progress until the distribution is Deployed.
7. Add a new CNAME record to your DNS for your custom domain pointing to the CloudFront Domain Name for your Distribution. This can be found by clicking on your Distribution ID, under the General tab, Distribution domain name (for example, fd1fbc7cac6197.cloudfront.net).

Configuring Your Own Reverse Proxy Server

You can configure your own reverse proxy server for your API documentation. In the following example, we will use Nginx as the reverse proxy server.

1. Add the following content to the Nginx configuration file for simple configuration.

server {
    ...
    location / {
        proxy_pass  http://{projectId}.apidog.io;
        proxy_set_header X-Apidog-Project-ID {projectId};
        # Set your custom domain name to the Host value (Eg. docs.example.com).
        proxy_set_header Host docs.example.com;
        ...
    }
    ...
}

Caddy configuration example:

:8080 {
        handle_path /* {
                reverse_proxy http://{projectId.apidog.io {
                        header_up X-Apidog-Project-ID {projectId}
                        header_up Host "docs.example.com"
                }

      }
}
}

tip

You can find the {projectId} value in the Apidog project settings.

2. Configure DNS record for your custom domain name to point to your reverse proxy server.

Deploying API Documents to a Subdirectory of a Custom Domain

Apidog version needs to be ≥ 2.5.24.

Apidog's Reverse Proxy allows API documents to be deployed to a subdirectory of a custom domain. For instance, you can deploy the documentation to the /api-docs path on a domain like https://example.com. When users visit https://example.com/api-docs, they will be accessing the online API documentation hosted by Apidog.

Configuration Steps:

1. On Apidog's Custom Domain setting page, enter your custom domain.
2. Select Reverse Proxy and enable Use Subdirectory, then enter the subdirectory path.

3. Next, you'll need to modify the configuration file of your web server. Assuming you're using Nginx to proxy your service, you can refer to the following configuration:

• proxy_pass: Forward client requests to another server (such as Apidog’s API documentation server).
• proxy_set_header: Set request headers sent by the proxy server to the upstream server, ensuring the request is properly handled.

server {
    ...
    location /api-docs/ {
        proxy_pass  http://{projectId}.apidog.io/;
        
        proxy_set_header X-Apidog-Project-ID {projectId};
        
        # Set your custom domain name to the Host value (Eg. docs.example.com).
        proxy_set_header Host docs.example.com;
        ...
    }
    ...
}

caution

• /api-docs/ is the subdirectory of the custom domain, and it must end with a / in the Nginx configuration.
• http://{projectId}.apidog.io/ must also end with a /.
• Replace {projectId} with your Apidog project ID.
• docs.example.com is a sample custom domain. Replace it with your actual custom domain.
• After configuration, you need to restart Nginx on your server.

Enabling HTTPS

Apidog's online documentation supports the HTTPS protocol, which has several advantages over HTTP:

• Secure Data Transmission: HTTPS uses SSL/TLS encryption to ensure the security of data transmission, preventing third parties from intercepting information.
• SEO Optimization: HTTPS enhances website security and privacy protection, which often leads to higher authority scores from search engines.

Steps to Enable HTTPS:

1. Go to the Publish page and open the Custom Domain tab.
2. Switch on HTTPS to enable HTTPS, and optionally, you can enable Always Use HTTPS to prevent communication from being hijacked or man-in-the-middle attacks.

SSL Certificate Management

Once HTTPS is enabled, you can choose how to manage your SSL certificate:

• Generated by Apidog: Apidog will automatically generate an SSL certificate.
• Use Your Own Certificate: You can upload an SSL certificate and private key issued by a certificate authority(e.g., Let's Encrypt).

Troubleshooting

If you are having issues setting up your custom domain, please contact us via Discord.

Are you using Apidog Europe?

If you are using Apidog Europe, please ensure that you are using the correct domain for your custom domain setup.

The correct domain for Apidog Europe in previous setup is {projectId}.eu.apidog.com.