Edit
Report

Dev Portal

Empower API consumers with self-service API documentation and developer tools
All Dev Portal Documentation

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 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

Get started

Create a Dev Portal

Konnect allows you to publish, document, and secure APIs to drive adoption for any developer audience. You can create multiple Dev Portals based on selected APIs with appropriate visibility and access control settings.

Add APIs to Dev Portal

Dev Portal APIs serve as a repository for your API specifications and documentation. You can optionally version your APIs and publish them to one or more Portals. This supports maintaining a central source of truth while offering developer-specific visibility.

Publish APIs to Dev Portal

Learn how to publish APIs with Dev Portal and control who can see published APIs.

Allow developers to register apps

Configure application registration and role-based access for developers. Grant or revoke access for developers to register applications and acquire credentials.

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

Customize Dev Portal

Custom pages

Customize Dev Portal Pages using Markdown Components (MDC).

Snippets

Snippets allow you to reuse content and MDC components across Pages.

Custom domains

Use a custom URL for Dev Portal.

Customization settings

Change the Dev Portal UI appearance.

Dev Portal settings

Learn about the settings you can configure for Dev Portal.

Developer authentication and access

Access and authentication settings

Security settings help you configure visibility and access control for developers accessing your Dev Portal.

SSO

Set up SSO for the Konnect Dev Portal using OpenID Connect (OIDC) or SAML.

IdP team mappings

Map existing developer teams from a third-party identity provider (IdP) and their permissions to elements in a Konnect Dev Portal.

Application registration

Self-service developer and application registration

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

Developer sign-up

Learn how developers can get started with the Dev Portal by registering and creating an application.

Developer and application approvals

Approve and manage developer registrations and applications for the Konnect Dev Portal.

Authentication strategies

Learn how to set up authentication strategies for Dev Portal.

Dynamic Client Registration

Learn how to dynamically create developer applications in an IdP.

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.

Something wrong?
Report an Issue | Edit this Page

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!
Contribute

Still need help

Ask in our Forum
Contact Support