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, through which you manage your APIs, consumers, and more. Data sent through the Admin API is stored in Kong's datastore (Kong supports PostgreSQL and Cassandra).

  1. Start Kong

    Issue the following command to prepare your datastore by running the Kong migrations:

    $ kong migrations up [-c /path/to/kong.conf]
    

    You should see a message that tells you Kong has sucessfully migrated your database. If not, you probably incorrectly configured your database connection settings in your configuration file.

    Now let's start Kong:

    $ kong start [-c /path/to/kong.conf]
    

    Note: the CLI accepts a configuration option (-c /path/to/kong.conf) allowing you to point to your own configuration.

  2. Verify that Kong has started successfully

    If everything went well, you should see a message (Kong started) informing you that Kong is running.

    By default Kong listens on the following ports:

  • :8000 on which Kong listens for incoming HTTP traffic from your clients, and forwards it to your upstream services.
  • :8443 on which Kong listens for incoming HTTPS traffic. This port has a similar behavior as the :8000 port, except that it expects HTTPS traffic only. This port can be disabled via the configuration file.
  • :8001 on which the Admin API used to configure Kong listens.
  • :8444 on which the Admin API listens for HTTPS traffic.
  1. Stop Kong

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

    $ kong stop
    
  2. 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