In order to give you better service we use cookies. By continuing to use our website, you agree to the use of cookies as described in our Cookie Policy

Kong Logo
  • Request Demo
  • Install
  • Products
    • Kong Gateway
      Install Kong Open Source
      • Overview
      • Control API

        Own your Kong experience to customize your API and microservices workflows.

      • Kong Proxy

        Deliver performance needed for microservices, service mesh, and cloud native deployments.

        • Overview
        • Multi-protocol
      • Kong Plugins

        Unleash the full power of Kong with a robust ecosystem of plugins.

    • Kong Enterprise
      DemoFree Trial
      • Overview
      • Kong Manager

        Monitor and manage all your services with a consumer-grade interface.

        • Overview
      • Teams

        Organize developers and assign permissions to improve efficiency and compliance.

        • Overview
        • RBAC
        • Workspaces
      • Kong Studio

        Empower your developers with the Kong Studio Integrated Development Environment.

      • Dev Portal

        Accelerate innovation across your organization with the Kong Developer Portal.

      • Brain

        Automatically standardize documentation and create a visual map of your services.

      • Immunity

        Autonomously identify service issues with machine learning-powered anomaly detection.

      • Kong for Kubernetes

        The only fully native Kubernetes Ingress Controller for enhanced API management.

      • Enterprise Plugins

        Instantly implement policies built for global scale with Kong Enterprise Plugins.

      • Vitals

        Monitor your Kong Enterprise health and microservice API transactions traversing Kong.

  • Solutions
    • API Gateway

      Take control of your microservices traffic with the world’s most popular API gateway.

    • Kubernetes

      Own your Kubernetes cluster by extending Kong functionality as an ingress controller.

    • Service Mesh

      Inject Kong as a sidecar for your services to go from mess to mesh.

  • Plugins
  • Open Source
    • Install Kong Gateway
    • Kong Community
    • Kubernetes Ingress
    • Kuma
    • Insomnia
  • Docs
    • Get Started
      • Install Kong Gateway
      • Install Kong Enterprise
    • Learn
      • Kong Gateway
      • Kong Enterprise
      • Kong Studio
      • Plugins Hub
  • Resources
    • Learning
      • eBooks
      • Webinars
      • Briefs
      • Blog
      • API Gateway
      • Microservices
    • Community
      • Community
      • Kong Nation
      • Kong Summit
      • GitHub
    • Support
      • Enterprise Support Portal
      • FAQS
  • Company
    • About
    • Customers
    • Investors
    • Careers
    • Partners
    • Press
    • Contact
  • Request Demo
Edit this Page
Kong Kong Enterprise Kong Studio Open Sidebar
Documentation

FAQ Kong Developer Portal

  • 1.3-x (2020) (latest)
  • 0.36-x
  • 0.35-x
  • 0.34-x
  • 0.33-x
  • 0.32-x
  • 0.31-x
Getting Started
  • Introduction
  • Five-minute quickstart
  • Adding your API
  • Enabling Plugins
  • Adding Consumers
  • Licensing
  • Accessing Your License
Installation
  • Docker
  • CentOS
  • Amazon Linux
  • Ubuntu
APIs and Plugins
  • Canary Release Plugin
  • Rate Limiting Advanced Plugin
  • Request Transformer Plugin
  • OAuth2 Introspection Plugin
  • OpenID Connect Plugin
  • HTTP Proxy Caching
  • Forward Proxy
  • RBAC API
Kong Developer Portal
  • Overview
  • Glossary
  • Configuration
    • Getting Started
    • Authentication
    • Networking
    • Property Reference
  • Managing Developers
  • Developer Access
  • File Management
  • Customization
  • FAQ
Guides & References
  • Kong Enterprise Changelog
  • Architecture Overview
  • Architecture Patterns
  • Accessing Admin GUI
  • Kong Vitals
  • Rate Limiting Library
  • Setting Up Admin API RBAC
  • Kong Enterprise Edition Versioning
  • Multiple Authentication Methods
  • PostgreSQL on RedHat
  • OpenID Connect with Google
  • OpenID Connect with Auth0
  • Upgrades and Migrations
Careful! You are browsing documentation for an outdated version of Kong. Go here to browse the documentation for the latest version.

Table of Contents

  • Why do I get {"message":"not found"} when I visit my Developer Portal?
  • Why do I see No Files Found when I visit my Developer Portal?
  • Why do I have files with unauthenticated/ in them?
  • What file types are supported?
  • Does the developer portal support uploading images, scripts, and videos?
  • Can I use other API specification formats like API Blueprint?
  • Can I modify the Header and Meta tags?
  • Can I host my API spec files outside of the File API?
  • Can I write my content in markdown?
  • Can I change the code snippet languages displayed on my documentation?

FAQ

Why do I get {"message":"not found"} when I visit my Developer Portal?

You most likely have not configured the portal property correctly. Check your Kong Configuration and ensure that portal is set to on.

Why do I see No Files Found when I visit my Developer Portal?

This can be caused by a few reasons:

  1. Missing developer portal files. (127.0.0.1:8001/files)
  2. Improper Network configuration.

If you have confirmed that you have files and your network setup is properly configured, please contact support for further assistance.

Why do I have files with unauthenticated/ in them?

When a user requests a particular page to access that they are not authorized to view, the Dev Portal will check for the same filename under the unauthenticated namespace to serve instead. For this reason unauthenticated is a reserved namespace, and should only be used for portals that have Authentication enabled.

What file types are supported?

You can find a list of supported template types on the File Management page.

Does the developer portal support uploading images, scripts, and videos?

Currently the Kong Developer Portal only supports text based content, custom scripts & styles, can be added by leveraging partials.

Media like images, SVGs, and videos should be encoded and inserted inline or hosted elsewhere and referenced.

Can I use other API specification formats like API Blueprint?

Currently only Swagger 2 and OpenAPI 3 are supported.

Can I modify the Header and Meta tags?

Direct modification of the <meta> and <head> tags is currently not supported, you can accomplish this through Custom JS included as a handlebars partial.

Can I host my API spec files outside of the File API?

Currently the Kong Developer Portal can only render API specifications that are served by the File API.

Can I write my content in markdown?

Currently content written in Markdown format is not supported.

Can I change the code snippet languages displayed on my documentation?

Yes! You can change the display and languages of the code snippets by modifying the unauthenticated/code-snippet-languages.hbs partial through the Portal API. See Updating Files for more information.

  • Kong
    Star
  • Products
    • Kong
    • Kong Enterprise
    • Kong Studio
    • Subscriptions
  • Resources
    • Enterprise Support
    • Documentation
    • Partners
    • Webinars
    • Ebooks
  • Company
    • About
    • Customers
    • Investors
    • News
    • Careers Hiring!
    • Kong Summit
    • Contact
  • Open Source
    • Install
    • GitHub
    • Kong Nation
    • Community
  • © Kong Inc. 2019   Terms•Privacy