Dev Portal

Empower API consumers with self-service API documentation and developer tools

The Konnect Dev Portal is a customizable website for developers to locate, access, and consume API services. It enables developers to browse and search API documentation, try API operations, and manage their own credentials. The Portal supports both internal and external APIs through flexible deployment options.

Dev Portal APIs allow you to publish APIs using OpenAPI or AsyncAPI specifications and Markdown documentation. You can provide highly customizable content at both the site and API level to offer additional context to developers.

KongAir Dev Portal

Deployment options

Internal Dev Portal

Designed for internal developer enablement and productivity.

  • Private visibility with authentication enabled
  • Publish internal-only APIs
  • Use Pages for API standards and training
  • Secure access via IdP and Teams

Partner Dev Portal

Ideal for exposing APIs to trusted external developers.

  • Private or public visibility with auth enabled
  • Self-service registration and API key provisioning
  • Restrict access via RBAC and visibility settings
  • Brand and document your partner use cases

Public Dev Portal

Open your APIs to the broader developer community.

  • Public visibility without authentication
  • Publish APIs suited to general audiences
  • Build custom landing pages and SEO-optimized docs

Enterprise Portal and Vitals

As of Kong Gateway 3.5, the product component known as Kong Enterprise Portal is no longer included in the Kong Gateway Enterprise (previously known as Kong Enterprise) software package. Existing customers who have purchased Kong Enterprise Portal can continue to use it and be supported via a dedicated mechanism.

In addition, the product component known as Vitals is no longer included in Kong Gateway Enterprise. Existing customers who have purchased Kong Vitals can continue to use it and be supported via a dedicated mechanism. Kong Konnect users can take advantage of our API Analytics offering, which provides a superset of Vitals functionality.

If you have purchased Kong Enterprise Portal or Vitals in the past and would like to continue to use it with this release or a future release of Kong Gateway Enterprise, contact Kong Support for more information.

For the official statement, see Kong Gateway 3.5 breaking changes.

Get started

Define Dev Portal teams and roles

Before you can start using your Dev Portal, a Konnect or Dev Portal admin must assign users to Konnect teams and roles. This allows Konnect users to access their respective features in Dev Portal.

Create an API catalog

Create and publish APIs to Dev Portal manually or with automation. Discover and govern APIs from third-parties with Catalog.

Customize Dev Portal

Customize Dev Portal pages, domains, and appearance.

Developer self-service

Enable self-service registration flows for developers and applications using authentication strategies and Konnect application auth.

Developer and agent authentication and access

You can allow both developers and agents to access your Dev Portal. Enabling AI agent access to Dev Portal isn’t a separate flow from enabling developers, it builds on the same developer authentication and access settings. After a developer is set up, they can also connect their own AI agent to browse and, depending on configuration, act on their behalf.

For developers

Configure authentication, SSO, IdP team mappings, and RBAC for developers accessing your Dev Portal.

ModelContextProtocol

For AI agents

Generate an MCP server from the APIs published to a Dev Portal so developers can connect their AI agents to browse and, depending on configuration, use them.

Dev Portal analytics

In Dev Portal, you can view both analytics for developer applications as well as platform-wide analytics for all Dev Portals.

For more information, see Dev Portal analytics.

Migrate from classic Dev Portal (v2)

With the GA release of the new Dev Portal (v3) in June 2025, you can migrate from classic Dev Portals (v2) to the new Dev Portal.

See the migration guide to learn how to migrate from the classic Dev Portal (v2) to the new Dev Portal (v3).

Frequently asked questions

There is a soft limit of four Dev Portals per Konnect org. Reach out to your Kong customer success team to increase this limit.

You may need to add specific hostnames or IP addresses to an allowlist so that communication can reach Konnect uninterrupted. See Networking in Konnect for the required ports and hostnames.

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!