Maybe you were looking for the Enterprise Edition (EE) Documentation instead?
Careful! You are browsing documentation for an outdated version of Kong. Go here to browse the documentation for the latest version.

5-minute Quickstart

Before you start: Make sure you've installed Kong — It should only take a minute!

In this section, you'll learn how to manage your Kong instance. First we'll have you start Kong giving in order to give you access to the RESTful Admin interface to manage your APIs, consumers, and more. Data sent through the Admin API is stored in Kong's datastore (as of 0.8.0, Kong supports PostgreSQL and Cassandra).

Note: make sure you have your database instance running and configured in Kong.

  1. Start Kong.

    Issue the following command to start Kong:

    $ kong start

    Note: The CLI also accepts a configuration (-c <path_to_config>) option allowing you to point to different configurations.

  2. Verify that Kong has started successfully

    The previous step runs migrations to prepare your database. Once these have finished you should see a message ([OK] Started) informing you that Kong is running.

    By default Kong listens on the following ports:

    :8000 - Proxy layer for API requests

    :8001 - RESTful Admin API for configuration

  3. Stop Kong.

    As needed you can stop the Kong process by issuing the following command:

    $ kong stop
  4. Reload Kong.

    Issue the following command to reload Kong without downtime:

    $ kong reload

Next Steps

Now that you have Kong running you can interact with the Admin API.

To begin, go to Adding your API ›

Keep up with the latest features