dev-portal.yaml

metadata:
  title: "Dev Portal"
  content_type: landing_page
  description: Manage API publishing, developer self-service, and documentation with Konnect Dev Portal.
  products:
    - dev-portal

rows:

  - header:
      type: h1
      text: "Dev Portal"
      sub_text: Empower API consumers with self-service API documentation and developer tools

  - columns:
      - blocks:
          - type: structured_text
            config:
              blocks:
                - type: text
                  text: |
                    {:.warning}
                    > [Review domain breaking changes for Dev Portal v3](/dev-portal/breaking-changes/)
  
  - columns:
      - blocks:
          - type: structured_text
            config:
              blocks:
                - type: text
                  text: |
                    The {{site.konnect_short_name}} 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.
          - type: button
            config:
              text: "Create a Dev Portal in {{site.konnect_short_name}}"
              url: https://cloud.konghq.com/portals/create
      - blocks:
          - type: image
            config:
              url: /assets/images/dev-portal/create-portal.png
              alt_text: "KongAir Dev Portal"

  - header:
      type: h2
      text: "Deployment options"
    columns:
      - blocks:
        - type: structured_text
          config:
            blocks:
              - type: text
                text: |
                  <img src="/assets/icons/lock.svg" style="display:inline"/> **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
      - blocks:
        - type: structured_text
          config:
            blocks:
              - type: text
                text: |
                  <img src="/assets/icons/team.svg" style="display:inline"/> **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
      - blocks:
        - type: structured_text
          config:
            blocks:
              - type: text
                text: |
                  <img src="/assets/icons/world.svg" style="display:inline"/> **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

  - header:
      type: h2
      text: "Get started"
    columns:
      - blocks:
        - type: card
          config:
            title: Define Dev Portal teams and roles
            description: |
              Before you can start using your Dev Portal, a {{site.konnect_short_name}} or Dev Portal admin must assign users to {{site.konnect_short_name}} teams and roles. This allows {{site.konnect_short_name}} users to access their respective features in Dev Portal.
            icon: /assets/icons/rbac.svg
            ctas:
              - text: Pre-defined Dev Portal teams
                url: "/konnect-platform/teams-and-roles/#predefined-teams"
              - text: Dev Portal teams for common use cases
                url: "/konnect-platform/teams-and-roles/#dev-portal-custom-teams"
              - text: Catalog API roles
                url: "/konnect-platform/teams-and-roles/#catalog-apis"
              - text: Dev Portal roles
                url: "/konnect-platform/teams-and-roles/#dev-portal"
      - blocks:
        - type: card
          config:
            title: Create an API catalog
            description: |
              Create and publish APIs to Dev Portal manually or with automation. Discover and govern APIs from third-parties with {{site.konnect_catalog}}.
            icon: /assets/icons/api.svg
            ctas:
              - text: With the {{site.konnect_short_name}} API
                url: "/how-to/automate-api-catalog/"
              - text: With Terraform
                url: "/how-to/automate-api-catalog-with-terraform/"
              - text: Create and publish APIs
                url: "/catalog/apis/"
              - text: Create API packages
                url: /catalog/api-packaging/
              - text: Discover and govern APIs
                url: /how-to/discover-and-govern-apis-with-service-catalog/
  
      - blocks:
        - type: card
          config:
            title: Customize Dev Portal
            description: |
              Customize Dev Portal pages, domains, and appearance.
            icon: /assets/icons/edit.svg
            ctas:
              - text: About Dev Portal customization
                url: /dev-portal/customizations/dev-portal-customizations/
              - text: Pages and content
                url: "/dev-portal/pages-and-content/"
              - text: Custom domains
                url: "/dev-portal/custom-domains/"
              - text: Dev Portal settings
                url: "/dev-portal/portal-settings/"
      - blocks:
        - type: card
          config:
            title: Developer self-service
            description: |
              Enable self-service registration flows for developers and applications using authentication strategies and {{site.konnect_short_name}} application auth.
            icon: /assets/icons/team.svg
            ctas:
              - text: Self-service developer and app registration
                url: "/dev-portal/self-service/"
              - text: Developer sign-up
                url: "/dev-portal/developer-signup/"
              - text: Developer and application approvals
                url: "/dev-portal/self-service/#developer-and-application-approvals"
              - text: Authentication strategies
                url: "/dev-portal/auth-strategies/"
              - text: Developer RBAC
                url: "/dev-portal/developer-rbac/"


  - header:
      type: h2
      text: "Developer authentication and access"
  - columns:
      - blocks:
          - type: card
            config:
              title: Access and authentication settings
              description: |
                Security settings help you configure visibility and access control for developers accessing your Dev Portal.
              cta:
                url: "/dev-portal/security-settings/"
      - blocks:
          - type: card
            config:
              title: SSO
              description: |
                Set up SSO for the {{site.konnect_short_name}} Dev Portal using OpenID Connect (OIDC) or SAML.
              cta:
                url: "/dev-portal/sso/"
      - blocks:
          - type: card
            config:
              title: IdP team mappings
              description: |
                Map existing developer teams from a third-party identity provider (IdP) and their permissions to elements in a {{site.konnect_short_name}} Dev Portal.
              cta:
                url: "/dev-portal/team-mapping/"
      - blocks:
          - type: card
            config:
              title: Developer RBAC
              description: |
                Learn about pre-defined developer teams and roles for RBAC.
              cta:
                url: /dev-portal/developer-rbac/

  - header:
      type: h2
      text: "Dev Portal analytics"
    columns:
      - blocks:
        - type: structured_text
          config:
            blocks:
              - type: text
                text: |
                  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](/dev-portal/analytics/).
  - header:
      type: h2
      text: "Migrate from classic Dev Portal (v2)"
    columns:
      - blocks:
        - type: structured_text
          config:
            blocks:
              - type: text
                text: |
                  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](/dev-portal/v2-migration/) to learn how to migrate from the classic Dev Portal (v2) to the new Dev Portal (v3).

  - header:
      type: h2
      text: "References"
  - columns:
      - blocks:
          - type: card
            config:
              title: Dev Portal audit logs
              description: |
                Learn about what events are logged in Dev Portal logs.
              cta:
                url: "/konnect-platform/audit-logs/"
      - blocks:
          - type: card
            config:
              title: Dev Portal v3 breaking changes
              description: |
                Review breaking changes from Dev Portal v3 beta to general release.
              cta:
                url: "/dev-portal/breaking-changes/"

  - header:
      text: "Frequently asked questions"
      type: h2
    columns:
      - blocks:
        - type: faqs
          config:
            - q: How do I view Dev Portal documentation for {{site.base_gateway}} 3.4?
              a: Contact your account manager for {{site.base_gateway}} 3.4 documentation.