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

Documentation for Kong

  • 1.4.x (latest)
  • 1.3.x
  • 1.2.x
  • 1.1.x
  • 1.0.x
  • 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
  • Configuring a gRPC 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.nginx
    • kong.node
    • kong.request
    • kong.response
    • kong.router
    • kong.service
    • kong.service.request
    • kong.service.response
    • kong.table
Admin API
  • DB-less
  • Declarative Configuration
  • Supported Content Types
  • Information Routes
    • Retrieve Node Information
  • Health Routes
    • Retrieve Node Status
  • Tags
    • List All Tags
    • List Entity Ids by Tag
  • Service Object
    • Add Service
    • List Services
    • Retrieve Service
    • Update Service
    • Update Or Create Service
    • Delete Service
  • Route Object
    • Add Route
    • List Routes
    • Retrieve Route
    • Update Route
    • Update Or Create Route
    • Delete Route
  • Consumer Object
    • Add Consumer
    • List Consumers
    • Retrieve Consumer
    • Update Consumer
    • Update Or Create Consumer
    • Delete Consumer
  • Plugin Object
    • Add Plugin
    • List Plugins
    • Retrieve Plugin
    • Update Plugin
    • Update Or Create Plugin
    • Delete Plugin
    • Retrieve Enabled Plugins
    • Retrieve Plugin Schema
  • Certificate Object
    • Add Certificate
    • List Certificates
    • Retrieve Certificate
    • Update Certificate
    • Update Or Create Certificate
    • Delete Certificate
  • CA Certificate Object
    • Add CA Certificate
    • List CA Certificates
    • Retrieve CA Certificate
    • Update CA Certificate
    • Update Or Create CA Certificate
    • Delete CA Certificate
  • SNI Object
    • Add SNI
    • List SNIs
    • Retrieve SNI
    • Update SNI
    • Update Or Create SNI
    • Delete SNI
  • Upstream Object
    • Add Upstream
    • List Upstreams
    • Retrieve Upstream
    • Update Upstream
    • Update Or Create Upstream
    • Delete Upstream
    • Show Upstream Health for Node
  • Target Object
    • Add Target
    • List Targets
    • Delete Target
    • Set Target Address As Healthy
    • Set Target Address As Unhealthy
    • Set Target As Healthy
    • Set Target As Unhealthy
    • List All Targets
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 →

DB-less & Declarative Configuration

Learn how to leverage the declarative configuration format for using Kong without a database, using in-memory storage only.

Read the tutorial →

Kong for Kubernetes

Get Started with Kong for Kubernetes

Learn More →

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