Using custom domains

Custom documentation domains are available on Postman Team, Business, and Enterprise plans.

You can use a custom domain for your API documentation.

Adding a custom domain

In the Postman web dashboard, select Team Settings from the Team tab.

edit view for team

In the Custom Domains section, you will see a list of domains indicated with verification status. Click + Add a new domain.

custom domain

In the Add a Custom Domain page, enter the URL of the domain you want to add. Your custom domain can be a full domain or a subdomain. For example, you can use either example.com or api.example.com.

enter custom domain

Click Proceed to verify the domain.

Verifying your domain

When you add a custom domain, you will see a modal displaying the DNS records required to verify domain ownership. To verify that you control the domain you're attempting to add, you must add these provided tokens as DNS records to your domain for TXT and CNAME.

see TXT and CNAME

Adding DNS records

For DNS records, verify the ownership with a DNS web service provider. In a separate browser tab, go to the DNS provider’s console and add the following two new records.

  1. A TXT record for postman-echo.com verifies the ownership of the domain. The value should be the same as the token shown in the modal. Add the TXT record to the root domain. For example if you're adding example.com or api.example.com, add the TXT record to example.com.
  2. A CNAME record for docs.postman-echo.com, as shown in the modal—this should be phs.getpostman.com. Add the CNAME record to the URL that's associated with your public documentation.

To verify the domain, check the I've added the TXT and CNAME records checkbox, then click Verify Domain. A confirmation message should indicate that the domain has been verified.

verify_domain

Postman uses LetsEncrypt as an SSL certificate provider to enable hosting public documentation on your domain. LetsEncrypt generates a certificate implicitly if your domain has no CAA records. If your domain has CAA records set, then LetsEncrypt needs an explicit CAA record to issue a certificate for that domain. To enable LetsEncrypt issue this certificate, refer to the LetsEncrypt Documentation.

If you don't want to verify the domain now, click Verify Later.

You can remove the custom domain by clicking Delete Custom Domain.

Your DNS settings may take up to 24 hours to take effect, and you may receive an error message in the interim. To check the status, you can visit this website.

Troubleshooting DNS issues

If you receive the error message

RRSet of type CNAME with DNS name <subdomain.domain.com> is not permitted as it conflicts with other records with the same DNS name in zone <domain.com>

when adding your first domain, note that CNAME records cannot co-exist with any other records for a domain. You will need to either edit the existing record type for your subdomain to CNAME or add a new subdomain.

If you receive the same message when adding your second domain, note that since the TXT record verifies the ownership of the domain, the value should be the same as the token already added for the root domain. Add the CNAME record to the URL that's associated with your public documentation, for which the value should be phs.getpostman.com.

Publishing a collection on your custom domain

When your domain is verified, you can use it to publish your API documentation. If you have a collection already published, you can edit it to use the new domain.

publish collection