Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
Kong Logo | Kong Docs Logo
  • Docs
    • Explore the API Specs
      View all API Specs View all API Specs View all API Specs arrow image
    • Documentation
      API Specs
      Kong Gateway
      Lightweight, fast, and flexible cloud-native API gateway
      Kong Konnect
      Single platform for SaaS end-to-end connectivity
      Kong AI Gateway
      Multi-LLM AI Gateway for GenAI infrastructure
      Kong Mesh
      Enterprise service mesh based on Kuma and Envoy
      decK
      Helps manage Kong’s configuration in a declarative fashion
      Kong Ingress Controller
      Works inside a Kubernetes cluster and configures Kong to proxy traffic
      Kong Gateway Operator
      Manage your Kong deployments on Kubernetes using YAML Manifests
      Insomnia
      Collaborative API development platform
  • Plugin Hub
    • Explore the Plugin Hub
      View all plugins View all plugins View all plugins arrow image
    • Functionality View all View all arrow image
      View all plugins
      AI's icon
      AI
      Govern, secure, and control AI traffic with multi-LLM AI Gateway plugins
      Authentication's icon
      Authentication
      Protect your services with an authentication layer
      Security's icon
      Security
      Protect your services with additional security layer
      Traffic Control's icon
      Traffic Control
      Manage, throttle and restrict inbound and outbound API traffic
      Serverless's icon
      Serverless
      Invoke serverless functions in combination with other plugins
      Analytics & Monitoring's icon
      Analytics & Monitoring
      Visualize, inspect and monitor APIs and microservices traffic
      Transformations's icon
      Transformations
      Transform request and responses on the fly on Kong
      Logging's icon
      Logging
      Log request and response data using the best transport for your infrastructure
  • Support
  • Community
  • Kong Academy
Get a Demo Start Free Trial
Kong Konnect
  • Home icon
  • Kong Konnect
  • Dev Portal
  • Create a Dev Portal
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Kong AI Gateway
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • Introduction
    • Overview of Konnect
    • Architecture
    • Network Resiliency and Availability
    • Port and Network Requirements
    • Private Connections to Other Cloud Providers
      • Create a private connection with AWS PrivateLink
    • Geographic Regions
    • Centralized consumer management
    • Compatibility
    • Stages of Software Availability
    • Release Notes
    • Support
      • Control Plane Upgrades FAQ
      • Supported Installation Options
  • Get Started
    • Overview
    • Add your API
    • Migrating a Self-Managed Kong Gateway into Konnect
  • Gateway Manager
    • Overview
    • Dedicated Cloud Gateways
      • Overview
      • Provision a Dedicated Cloud Gateway
      • Securing Backend Traffic
      • Transit Gateways
      • Azure VNET Peering
      • Custom Domains
      • Custom Plugins
      • Data plane logs
    • Serverless Gateways
      • Overview
      • Provision a serverless Gateway
      • Securing Backend Traffic
      • Custom Domains
    • Data Plane Nodes
      • Installation Options
      • Upgrade a Data Plane Node
      • Verify a Data Plane Node
      • Secure Control Plane/Data Plane Communications
      • Renew Data Plane Certificates
      • Parameter Reference
      • Using Custom DP Labels
    • Control Plane Groups
      • Overview
      • Working with Control Plane Groups
      • Migrate Configuration into Control Plane Groups
      • Conflicts in Control Planes
    • Kong Gateway Configuration in Konnect
      • Overview
      • Manage Plugins
        • Overview
        • Adding Custom Plugins
        • Updating Custom Plugins
        • How to Create Custom Plugins
      • Create Consumer Groups
      • Secrets Management
        • Overview
        • Konnect Config Store
        • Set Up and Use a Vault in Konnect
      • Manage Control Plane Configuration with decK
    • Active Tracing
      • Overview
    • KIC Association
    • Backup and Restore
    • Version Compatibility
    • Troubleshooting
  • Mesh Manager
    • Overview
    • Create a mesh with the Kubernetes demo app
    • Federate a zone control plane to Konnect
    • Migrate a self-managed zone control plane to Konnect
  • Service Catalog
    • Overview
    • Integrations
      • Overview
      • Datadog
      • GitHub
      • GitLab
      • PagerDuty
      • SwaggerHub
      • Traceable
      • Slack
    • Scorecards
  • API Products
    • Overview
    • Product Documentation
    • Productize a Service
  • Dev Portal
    • Overview
    • Dev Portal Configuration Preparation
    • Create a Dev Portal
    • Sign Up for a Dev Portal Account
    • Publish an API to Dev Portal
    • Access and Approval
      • Manage Developer Access
      • Manage Developer Team Access
      • Add Developer Teams from IdPs
      • Manage Application Registrations
      • Configure generic SSO for Dev Portal
      • Configure Okta SSO for Dev Portal
    • Application Lifecycle
    • Register and create an application as a developer
    • Enable and Disable App Registration for API Product Versions
    • Dynamic Client Registration
      • Overview
      • Okta
      • Curity
      • Auth0
      • Azure
      • Custom IdP
    • Portal Management API Automation Guide
    • Audit Logging
      • Overview
      • Set up an Audit Log Webhook
      • Set up an Audit Log Replay Job
    • Portal Customization
      • Overview
      • About Self-Hosted Dev Portal
      • Host your Dev Portal with Netlify
      • Custom Domains
    • Dev Portal SDK
    • Troubleshoot
  • Advanced Analytics
    • Overview
    • Dashboard
    • Explorer
    • Analyze API Usage and Performance with Reports
    • Requests
  • Org Management
    • Plans and Billing
    • Authentication and Authorization
      • Overview
      • Teams
        • Overview
        • Manage Teams
        • Teams Reference
        • Roles Reference
      • Manage Users
      • Manage System Accounts
      • Personal Access Tokens
      • Social Identity Login
      • Org Switcher
      • Configure Generic SSO
      • Configure Okta SSO
      • Login Sessions Reference
      • Troubleshoot
    • Audit Logging
      • Overview
      • Set up an Audit Log Webhook
      • Set up an Audit Log Replay Job
    • Account and Org Deactivation
  • API
    • Overview
    • API Request API (Beta)
      • API Spec
    • API Products API
      • API Spec
    • Audit Logs API
      • API Spec
      • Audit Log Webhooks
    • Control Plane API
      • API Spec
    • Control Plane Configuration API
      • API Spec
    • Cloud Gateways API
      • API Spec
    • Identity API
      • API Spec
      • Identity Integration Guide
      • SSO Customization
    • Konnect Search API (Beta)
      • API Spec
    • Mesh Manager API
      • API Spec
      • Kong Mesh API Reference
    • Portal Client API
      • API Spec
    • Portal Management API
      • API Spec
    • Reference
      • Filtering
      • API Errors
  • Reference
    • Labels
    • Plugin Ordering Reference
    • Konnect Search
    • Terraform Provider
    • Audit Logs
    • Verify audit log signatures
    • IdP SAML attribute mapping
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Create a Dev Portal
  • Access the Dev Portal
  • Next steps
    • Configure developer settings
    • Configure Dev Portal customization
    • Publish APIs to Dev Portals
    • Configure audit logs for Dev Portal
Looking for the new Developer Portal beta docs? Try the beta now.

Create a Dev Portal

The Konnect Dev Portal is a customizable website for developers to locate, access, and consume API services.

You can create both public and private Dev Portals, depending on your use case. Public Dev Portals don’t require users to login to see published APIs, and are discoverable on the internet. Private Dev Portals require users to create an account and log in to see published APIs, and are not discoverable on the internet.

When Dev Portal admins require developers to create an account and log in to use the Dev Portal, developers can “self serve” their API consumption. Developers can create applications, register them to their target APIs, and generate credentials to start consuming those APIs.

Create a Dev Portal

Konnect UI
Konnect API
  1. In dev-portal icon Dev Portal, click Dev Portal on the top right.
  2. In the Create Dev Portal dialog, configure your Dev Portal settings:
    1. Enter general information for your Dev Portal, including a name and optional description.
    2. Select if you want the Dev Portal to be private or public. Anyone can see APIs published to a public portal while only registered and logged in users can see APIs in a private portal. Developers can only get credentials and start consuming APIs through self service in a private Dev Portal.
    3. Private Dev Portal only: Configure the following settings:
      • Auto Approve Developers: If you enable this setting, this will allow developers to automatically be approved when they sign up for your private Dev Portal. If you don’t enable this, you must configure single sign-on or manually approve developers as they register.
      • Auto Approve Applications: If you enable this setting, apps that developers create with your APIs will be automatically approved. If you don’t enable this, you must manually approve or deny application registrations.
      • Portal RBAC: Portal RBAC allows you to assign developers to teams and roles that determine if they can only view or view and consume the APIs in your Dev Portal.
      • Default Application Auth Strategy: Select the auth strategy you want the APIs in your Dev Portal to use if they require authentication. This auth strategy will be how developers authenticate when they register to consume your APIs. Selecting a default auth strategy makes it easier for your API Product owners to publish an API to a Dev Portal that requires authentication, because the default auth strategy will be auto selected for them. If you’re not sure which auth strategy to use, you can select the pre-created key-auth strategy.
    4. Optional: Configure the visual customization settings, such as a Dev Portal logo, favicon, and home page header image.
    5. Optional: Add labels to your Dev Portal. Labels will help you identify and search for your Dev Portal in Konnect.
  3. Click Save.
  4. Repeat steps 1-3 to create additional Dev Portals.

The Konnect API uses Personal Access Token (PAT) authentication. You can obtain your PAT from the personal access token page. The PAT must be passed in the Authorization header of all requests.

To create a Dev Portal, do one of the following:

  • Create a private Dev Portal using the /portals endpoint:
      curl --request POST \
      --url https://{region}.api.konghq.com/v2/portals \
      --header 'Authorization: <personal-access-token>' \
      --header 'Content-Type: application/json' \
      --data '{
          "name": "DEV_PORTAL_NAME",
          "is_public": false,
          "rbac_enabled": true,
          "auto_approve_applications": true,
          "auto_approve_developers": true,
          "custom_domain": "api.example.com",
          "custom_client_domain": "portal.example.com",
          "default_application_auth_strategy_id": "41f3adcb-5f5b-4c97-ab08-3ac2777aa6ab"
      }'
    

    Be sure to replace the PAT as well as the following placeholders with your own values:

    • name
    • rbac_enabled
    • auto_approve_applications
    • auto_approve_developers
    • custom_domain
    • custom_client_domain
    • default_application_auth_strategy_id Refer to the API spec for more information.

    You should receive a 201 response containing information about your Dev Portal.

  • Create a public Dev Portal using the /portals endpoint:
      curl --request POST \
      --url https://{region}.api.konghq.com/v2/portals \
      --header 'Authorization: <personal-access-token>' \
      --header 'Content-Type: application/json' \
      --data '{
      "name": "DEV_PORTAL_NAME",
      "is_public": true,
      "custom_domain": "api.example.com",
      "custom_client_domain": "portal.example.com"
      }'
    

    Be sure to replace the PAT token and placeholder values. You can use the following two values to further configure the Dev Portal:

    • custom_domain: Optional, you can configure this if you want to use a different URL for hosting your Dev Portal instead of Konnect. A CNAME for the portal’s default domain must be able to be set for the custom domain for it to be valid. After setting a valid CNAME, an SSL/TLS certificate will be automatically manged for the custom domain, and traffic will be able to use the custom domain to route to the portal’s web client and API.
    • custom_client_domain: Optional, you can configure this if you want to use a different URL for your Dev Portal other than the default one.

Access the Dev Portal

You can access the Dev Portal using the Dev Portal URL. The URL is displayed when you click dev-portal icon Dev Portal to open the Published API Products overview page. The Dev Portal URL looks like this:

https://{portalId}.{region}.portal.konghq.com/

Your Dev Portal URL may vary. Keep the following in mind:

  • The Dev Portal URL varies based on geographic location.
  • If you’re hosting your Dev Portal through Netlify, the Dev Portal URL is the one you specify in the Dev Portal sidebar under Settings > Portal Domain > Custom Self-Hosted UI Domain.

Next steps

Configure developer settings

  • Enable or Disable Application Registration for an API Product Version
  • Dynamic Client Registration Overview: Dynamic Client Registration (DCR) within Konnect Dev Portal allows applications created in the portal to automatically create a linked application in a third-party Identity Provider (IdP).

Configure Dev Portal customization

  • Customize the Konnect Dev Portal
  • Host your Dev Portal with Netlify

Publish APIs to Dev Portals

  • Add and publish API product documentation

Configure audit logs for Dev Portal

  • Dev Portal audit logs: Keep track of Dev Portal authentication, authorization, and access logs in a SIEM provider
Thank you for your feedback.
Was this page useful?
Too much on your plate? close cta icon
More features, less infrastructure with Kong Konnect. 1M requests per month for free.
Try it for Free
  • Kong
    Powering the API world

    Increase developer productivity, security, and performance at scale with the unified platform for API management, service mesh, and ingress controller.

    • Products
      • Kong Konnect
      • Kong Gateway Enterprise
      • Kong Gateway
      • Kong Mesh
      • Kong Ingress Controller
      • Kong Insomnia
      • Product Updates
      • Get Started
    • Documentation
      • Kong Konnect Docs
      • Kong Gateway Docs
      • Kong Mesh Docs
      • Kong Insomnia Docs
      • Kong Konnect Plugin Hub
    • Open Source
      • Kong Gateway
      • Kuma
      • Insomnia
      • Kong Community
    • Company
      • About Kong
      • Customers
      • Careers
      • Press
      • Events
      • Contact
  • Terms• Privacy• Trust and Compliance
© Kong Inc. 2025