Custom domains

Beta and uses: Dev Portal
Related Documentation
OpenAPI Specifications
Incompatible with
on-prem
Tags

Every Dev Portal instance has an auto-generated default URL. You can also manage custom URLs within Konnect. This gives users the ability to access the Dev Portal from either the default URL, for example https://example.edge.us.portal.konghq.com, or a custom URL like portal.example.com.

To add a custom URL to Dev Portal, you need:

  • A domain and access to configure the domain’s DNS CNAME records
  • Your organization’s auto-generated default Dev Portal URL
  • A CAA DNS record that only allows pki.goog if any pre-existing CAA DNS records are present on the domain

Configure DNS

In your DNS configuration, create a CNAME record for the domain you want to use using the automatically generated Dev Portal URL. The record will look like this:

Type

Name

Value

CNAME portal https://$YOUR_PORTAL_URL.edge.us.portal.konghq.com

If your domain has specific CAA DNS records that list authorized certificate authorities/issuers, you’ll also need to create a new CAA DNS record to permit Google Trust Services as an issuer. If your domain doesn’t currently have any CAA DNS records, it means all issuers are implicitly allowed, and there’s no need for a new CAA DNS record in that case.

Update Dev Portal URL settings

To add a custom URL to Dev Portal:

  1. In Konnect, select your Dev Portal and click Settings.

  2. Select Custom hosted domain.

  3. Enter the fully qualified domain name (FQDN) including the subdomain, if applicable, into the Custom Domain field. Don’t include a path or protocol (e.g. https://).

  4. Click Save Changes.

  5. CNAME status and SSL status will show Pending, while the DNS record TTL expires and SSL is configured. The status of these changes will update as they have been completed.

Domain name restrictions

Because of SSL certificate authority restrictions, Konnect can’t generate SSL certificates for the following domains:

  • TLDs containing a brand name: .aws, .microsoft, .ebay
  • Hosting provider subdomains: .amazonaws.com, .azurewebsites.net
  • TLDs restricted by US export laws:
    • .af Afghanistan
    • .by The Republic of Belarus
    • .cu Cuba
    • .er Eritrea
    • .gn Guinea
    • .ir Islamic Republic of Iran
    • .kp Democratic People’s Republic of Korea
    • .lr Liberia
    • .ru The Russian Federation
    • .ss South Sudan
    • .su Soviet Union
    • .sy Syrian Arab Republic
    • .zw Zimbabwe

If you have any questions, contact Support.

FAQs

Beta Dev Portals include edge before the region in the default URL (for example, example.edge.us.portal.konghq.com), whereas previous Dev Portals don’t.

To delete a custom domain, go to your Dev Portal, click Settings, then click the trash/delete icon next to the domain entry.

After DNS verification, Konnect will attempt to auto-generate an SSL certificate. This process may take several hours. If you try to access the custom domain before the certificate is ready, you may see an SSL error.

If the process takes more than 24 hours, check that your DNS record has propagated correctly.

Use the dig command to verify DNS configuration. Replace CUSTOM_DOMAIN and CUSTOM_DOMAIN_DNS with your actual values:

dig +nocmd @CUSTOM_DOMAIN_DNS cname CUSTOM_DOMAIN +noall +answer

The output should show something like:

portal.example.com. 172 IN CNAME example.edge.us.portal.konghq.com.

This confirms that your custom domain points to the expected default domain.

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!