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

  • Products
    Service Control Platform
    Platform Overview Kong Manager Kong Dev Portal Kong Vitals Kong Brain Kong Immunity
    Offerings
    Kong

    The blazingly fast open source microservices API gateway.

    Kong Enterprise

    The next-generation API platform built on top of Kong.

    Kong Cloud

    Kong Enterprise innovation delivered at cloud speed.

  • Solutions
    API Gateway

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

    Kubernetes Ingress

    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.

  • Open Source
    Install

    Deploy Kong on your environment and platform of choice.


    Kubernetes Ingress

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

    GitHub

    Find code or file an issue for Kong’s code/documentation.

    Kong Nation

    Get help from Kong engineers and community members.

    Community

    Join the Kong community to find help or contribute to Kong.


  • Hub
Kong
  • Docs
    Kong Docs + Getting Started

    Use the 5-minute quickstart and installation guide to deploy Kong now.

    Deploy Kong Enterprise

    Use the quickstart and reference materials to launch Kong Enterprise today.

    Master Kong Vitals

    Learn how to implement Vitals and optimize it for your deployment.

    Launch your Dev Portal

    Learn how to create and manage your Kong Dev Portal.

  • Resources
    Connect
    Community Kong Nation GitHub Kong Summit
    Get Support
    Enterprise Support Portal FAQs
    Learn
    Blog Ebooks Webinars Briefs
  • Company
    aboutAbout
    investorsInvestors
    careersCareers
    partnersPartners
    pressPress
    contactContact
  • Request Demo
Request Demo Installation
Products  
  Products
Service Control Platform
Platform Overview Kong Manager Kong Dev Portal Kong Vitals Kong Brain Kong Immunity
Offerings
Kong Kong Enterprise Kong Cloud
Solutions  
  Solutions
API Gateway Kubernetes Ingress Service Mesh
Open Source  
  Open Source
Install GitHub Kong Nation Community
Hub
Docs  
  Docs
Kong Kong Enterprise Kong Vitals Dev Portal
Resources  
  Resources
Connect
Community Kong Nation GitHub Kong Summit
Get Support
Enterprise Support Portal
Learn
Blog Ebooks Webinars Briefs
Company  
  Company
About Investors Careers Partners Press Contact
Edit this Page
Kong Kong Enterprise
Documentation

Documentation for Kong

  • 1.0.x (latest)
  • 0.14.x
  • 0.13.x
  • 0.12.x
  • 0.11.x
  • 0.10.x
  • 0.9.x
  • 0.8.x
  • 0.7.x
  • 0.6.x
  • 0.5.x
  • 0.4.x
  • 0.3.x
  • 0.2.x
Getting Started
  • Introduction
  • Five-minute quickstart
  • Configuring a Service
  • Enabling Plugins
  • Adding Consumers
Guides & References
  • Configuration reference
  • CLI reference
  • Proxy reference
  • Authentication reference
  • Load balancing reference
  • Health checks and circuit breakers reference
  • Clustering reference
  • Logging reference
  • Network & Firewall
  • Securing the Admin API
  • Plugin Development Guide
    • Introduction
    • File structure
    • Implementing custom logic
    • Plugin configuration
    • Accessing the datastore
    • Storing custom entities
    • Caching custom entities
    • Extending the Admin API
    • Writing tests
    • (un)Installing your plugin
  • Plugin Development Kit
    • kong.client
    • kong.ctx
    • kong.ip
    • kong.log
    • kong.node
    • kong.request
    • kong.response
    • kong.router
    • kong.service
    • kong.service.request
    • kong.service.response
    • kong.table
Admin API
  • Supported Content Types
  • Information routes
    • Retrieve node information
    • Retrieve node status
  • Service Object
    • Add Service
    • Retrieve Service
    • List Services
    • Update Service
    • Update or create Service
    • Delete Service
  • Route Object
    • Add Route
    • Retrieve Route
    • List Routes
    • List Routes associated to a Service
    • Update Route
    • Update or create Route
    • Delete Route
  • Consumer Object routes
    • Create Consumer
    • Retrieve Consumer
    • List Consumers
    • Update Consumer
    • Update or create Consumer
    • Delete Consumer
  • Plugin Object routes
    • Add Plugin
    • Retrieve Plugin
    • List all Plugins
    • Update Plugin
    • Update or Add Plugin
    • Delete Plugin
    • Retrieve Enabled Plugins
    • Retrieve Plugin Schema
  • Certificate Object routes
    • Add Certificate
    • Retrieve Certificate
    • List Certificates
    • Update Certificate
    • Update or Create Certificate
    • Delete Certificate
  • SNI Object routes
    • Add SNI
    • Retrieve SNI
    • List SNIs
    • Update SNI
    • Update or Create SNI
    • Delete SNI
  • Upstream Object routes
    • Add Upstream
    • Retrieve Upstream
    • List all Upstreams
    • Update Upstream
    • Update or create Upstream
    • Delete Upstream
    • Show Upstream health for node
  • Target Object routes
    • Add Target
    • List Targets
    • List All Targets
    • Delete Target
    • Set Target as Healthy
    • Set Target as Unhealthy
Maybe you were looking for the Enterprise Documentation instead?

Installation

You can install Kong on most Linux distributions and macOS. We even provide the source so you can compile yourself.

Install Kong →

5-minute Quickstart

Learn how to start Kong, add a Service, enable plugins, and add consumers in under thirty seconds.

Start using Kong →

Streams & Service Mesh

Want to use Kong over TCP traffic? Want to start using Service Mesh? Check our tutorial to learn how to do it.

Read the tutorial →

Kubernetes & Service Mesh

We have a quick demo repository showing how to run Kong Service Mesh on Kubernetes.

Visit the repo →

Upgrade guide

Already using Kong, and wanting to upgrade? Here's the step-by-step guide.

Read the upgrade guide →

Configuration file

Want to further optimize your Kong cluster, database, or configure NGINX? Dive into the configuration.

Start configuring Kong →

CLI reference

Want a better understanding of the CLI tool and its options? Browse the detailed command reference.

Use the CLI →

Admin API reference

Ready to learn the underlying interface? Browse the Admin API reference to learn how to start making requests.

Explore the interface →

Proxy reference

Learn every way to configure Kong to proxy your Services, serve them over SSL or use WebSockets.

Read the Proxy Reference →

Load balancing reference

Learn how to setup Kong to load balance traffic through replicas of your upstream services.

Read the Load balancing Reference →

Health checks & circuit breakers

Let Kong monitor the availability of your services and adjust its load balancing accordingly.

Learn about health checks and circuit breakers →

Clustering

If you are starting more than one node, you must use clustering to make sure all the nodes belong to the same Kong cluster.

Read the clustering reference →

Write your own plugins

Looking for something Kong does not do for you? Easy: write it as a plugin. Learn how to write your own plugins for Kong.

Read the plugin development guide →
  • Kong
    Star
  • Products
    • Kong
    • Kong Enterprise
    • Kong Cloud
    • Subscriptions
  • Resources
    • Enterprise Support
    • Documentation
    • Partners
    • Webinars
    • Ebooks
  • Company
    • About
    • Investors
    • News
    • Careers Hiring!
    • Kong Summit
    • Contact
  • Open Source
    • Install
    • GitHub
    • Kong Nation
    • Community
  • © Kong Inc. 2019   Terms•Privacy