Skip to content
Kong Logo | Kong Docs Logo
search
  • 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 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
      Kuma
      Open-source distributed control plane with a bundled Envoy Proxy integration
  • 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
      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 Gateway
2.6.x
  • Home icon
  • Kong Gateway
  • Developer Portal
  • How To Enable the Dev Portal
github-edit-pageEdit this page
report-issueReport an issue
  • Kong Gateway
  • Kong Konnect
  • Kong Mesh
  • Plugin Hub
  • decK
  • Kong Ingress Controller
  • Kong Gateway Operator
  • Insomnia
  • Kuma

  • Docs contribution guidelines
  • 3.5.x (latest)
  • 3.4.x
  • 3.3.x
  • 3.2.x
  • 3.1.x
  • 3.0.x
  • 2.8.x
  • 2.7.x
  • 2.6.x
  • Archive (pre-2.6)
enterprise-switcher-icon Switch to OSS
On this pageOn this page
  • Enable Dev Portal in the Kong Configuration
  • Enable Dev Portal with Docker installation
You are browsing documentation for an outdated version. See the latest documentation here.

How To Enable the Dev Portal

Enable Dev Portal in the Kong Configuration or within a Docker container for Docker installations.

Enable Dev Portal in the Kong Configuration

  1. To enable the Dev Portal, the following properties must be set in the Kong configuration file (kong.conf):

    portal = on
    

    Kong Gateway must be restarted for this value to take effect.

  2. Enable the default Workspace Dev Portal via Kong Manager:

    1. Navigate to the default Workspace in Kong Manager
    2. Click the Settings link under Dev Portal
    3. Toggle the Dev Portal Switch

    It may take a few seconds for the Settings page to populate.

    To enable the default Workspace’s Dev portal via the command line:

    curl -X PATCH http://localhost:8001/workspaces/default   --data "config.portal=true"
    
    • This will expose the default Dev Portal at http://localhost:8003/default
    • The Dev Portal Files endpoint can be accessed at :8001/files
    • The Public Dev Portal Files API can be accessed at :8004/files

Enable Dev Portal with Docker installation

This feature is only available with a Kong Konnect Enterprise subscription.

  1. Deploy a license.

  2. In your Docker container, set the Portal URL and set KONG_PORTAL to on:

     echo "KONG_PORTAL_GUI_HOST=localhost:8003 KONG_PORTAL=on kong reload exit" \
       | docker exec -i kong /bin/sh
    

    The HOSTNAME for KONG_PORTAL_GUI_HOST should not be preceded by a protocol, for example, http://.

  3. Execute the following command:

     curl -X PATCH --url http://localhost:8001/workspaces/default \
         --data "config.portal=true"
    
  4. Access the Dev Portal for the default workspace using the URL specified in the KONG_PORTAL_GUI_HOST variable:

     http://localhost:8003/default
    
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 Gateway Enterprise 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. 2023