You are browsing documentation for an outdated version of Kong. Go here
to browse the documentation for the latest version.
Table of Contents
Adding your API
In this section, you’ll be adding your API to the Kong layer. This is the first
step to having Kong manage your API. For purposes of this Getting Started
guide, we suggest adding the Mockbin API to Kong, as Mockbin is
helpful for learning how Kong proxies your API requests.
Kong exposes a RESTful Admin API on port
:8001 for managing the
configuration of your Kong instance or cluster.
1. Add your API using the Admin API
Issue the following cURL request to add your first API ([Mockbin][mockbin])
$ curl -i -X POST \
--url http://localhost:8001/apis/ \
--data 'name=example-api' \
--data 'hosts=example.com' \
2. Verify that your API has been added
You should see a similar response from that request:
HTTP/1.1 201 Created
Kong is now aware of your API and ready to proxy requests.
3. Forward your requests through Kong
Issue the following cURL request to verify that Kong is properly forwarding
requests to your API. Note that [by default][proxy-port] Kong handles proxy
requests on port `:8000`:
$ curl -i -X GET \
--url http://localhost:8000/ \
--header 'Host: example.com'
A successful response means Kong is now forwarding requests made to
`http://localhost:8000` to the `upstream_url` we configured in step #1,
and is forwarding the response back to us. Kong knows to do this through
the header defined in the above cURL request:
<li><strong>Host: <given host></strong></li>
Now that you’ve added your API to Kong, let’s learn how to enable plugins.
Go to Enabling Plugins ›