Skip to content
Kong Summit 2022: Where API Innovation Runs Wild  —Learn More →
Kong Logo | Kong Docs Logo
search
  • We're Hiring!
  • Docs
    • Kong Gateway
    • Konnect Cloud
    • Kong Mesh
    • Plugin Hub
    • decK
    • Kubernetes Ingress Controller
    • Insomnia
    • Kuma

    • Kong Konnect Platform

    • Docs contribution guidelines
  • Plugin Hub
  • Support
  • Community
  • Kong Academy
Request Demo
  • Kong Gateway
  • Konnect Cloud
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kubernetes Ingress Controller
  • Insomnia
  • Kuma

  • Kong Konnect Platform

  • Docs contribution guidelines
    • Using the Konnect Docs
    • Key Concepts and Terms
    • Access a Konnect Account
      • Manage a Konnect Account or Plan
      • Change to a Different Plan
      • Manage Payment Methods and Invoices
      • Manage Users and Roles
      • Set up SSO with Okta
    • Account and Org Deactivation
    • License Management
    • Port and Network Requirements
    • Network Resiliency and Availability
    • Migrate from Kong Gateway to Konnect Cloud
      • Set up a Runtime
      • Configure a Service
      • Implement and Test the Service
    • Manage Konnect Cloud with decK
    • Manage Services
      • Manage Service Documentation
      • Publish a Service to Dev Portal
      • Docker
      • Kubernetes
      • Linux
      • Runtime Parameter Reference
    • Upgrade a Runtime to a New Version
    • Renew Certificates
      • Developer Registration
      • Manage Developer Access
      • Auto Approve Dev and App Registrations
      • Application Overview
      • Create, Edit, and Delete an Application
      • Enable App Registration
      • Disable App Registration
      • Manage Application Registration Requests
      • Manage Application Connections
      • Register an Application with a Service
      • Generate Credentials for an Application
      • Appearance
      • Public Portal
      • Add a Custom Domain
    • Generating Vitals Reports
    • Configure a Plugin on a Service
    • Configure a Plugin on a Route
    • Configure Global or Consumer Plugins
    • Proxy Traffic
      • Konnect API Reference

github-edit-pageEdit this page

report-issueReport an issue

enterprise-switcher-iconSwitch to OSS

On this page
  • Prerequisites
  • Direct your CNAME to the default Dev Portal URL
  • Add a custom Dev Portal domain
Konnect Cloud
  • Home
  • Konnect Cloud
  • Dev portal
  • Customization

Add a Custom Domain

All Dev Portals have an auto-generated default Dev Portal URL. To further customize your Dev Portal, you can add a custom domain. When set up properly, users can access both the default URL and the custom URL.

Prerequisites

  • Access to your organization’s Konnect Admin UI.
  • A domain and access to configure that domain’s CNAME. Kong does not offer any custom domains as a service.
  • An X.509 certificate, which comes with a private key.
  • Your organization’s auto-generated default Dev Portal URL, which is in the Konnect Admin UI. For example, https://kong121212.portal.konnect.konghq.com/.

Direct your CNAME to the default Dev Portal URL

In your custom domain DNS records, direct your CNAME to your Dev Portal’s default URL. Check your DNS resolution to ensure this was done properly.

Add a custom Dev Portal domain

Add a custom Dev Portal domain through your organization’s Konnect Admin UI.

  1. Click Dev Portal, then Portal URL.

  2. Enter the following fields.

    • Custom Portal URL: Enter the full domain, including subdomain (if applicable). Don’t include a path. It’s not necessary to include the URL protocol, for example, https://.

    • X.509 Certificate: Obtain your certificate and add it to the field, including the certification header and footer. For example, a header may look like: -----BEGIN CERTIFICATE-----.

      This certificate ensures that your custom domain site is trusted and that the browser doesn’t show a warning when users land on the page.

    • Private Key: Add the private key that came with your X.509 certificate.

    Note: You will not be able to view or edit keys in the UI once you submit the form. To change your custom domain URL, X.509 certificate, or private key, delete your certificate and re-enter your custom domain URL, X.509 certificate, and private key.

  3. Once you’ve entered all fields, click Save Certificate.

  4. Test to see if your custom URL works. You’ll see the custom URL listed in your Dev Portal under your default Dev Portal URL, even if it doesn’t work properly.

    Your site may not resolve immediately. If you can’t reach your custom URL, check your DNS records. If there are no issues and your site is unreachable, wait for your site to propagate.

Thank you for your feedback.
Was this page useful?
  • Kong
    THE CLOUD CONNECTIVITY COMPANY

    Kong powers reliable digital connections across APIs, hybrid and multi-cloud environments.

    • Company
    • Customers
    • Events
    • Investors
    • Careers Hiring!
    • Partners
    • Press
    • Contact
  • Products
    • Kong Konnect
    • Kong Gateway
    • Kong Mesh
    • Get Started
    • Pricing
  • Resources
    • eBooks
    • Webinars
    • Briefs
    • Blog
    • API Gateway
    • Microservices
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Solutions
    • Decentralize
    • Secure & Govern
    • Create a Dev Platform
    • API Gateway
    • Kubernetes
    • Service Mesh
Star
  • Terms•Privacy
© Kong Inc. 2022