Add your API to Konnect

1. In the Gateway Manager, select the Default control plane.

2. Select Gateway Services from the side navigation bar, then New Gateway Service.

3. From the Add a Gateway Service dialog, create a new service:

   1. Enter a unique name for the Gateway service, or specify a Gateway service that doesn’t yet have a version connected to it.

      For the purpose of this example, enter example_gateway_service.

      The name can be any string containing letters, numbers, or the following characters: ., -, _, ~, or :. Do not use spaces.

      For example, you can use example_service, ExampleService, Example-Service. However, Example Service is invalid.

   2. In the Upstream URL field, enter https://httpbin.konghq.com.

   3. Use the defaults for the remaining fields.

   4. Click Save.

4. Add a route to your service implementation by clicking the Add a Route button now visible from the Gateway service dashboard.

   For this example, enter the following:

   • Name: httpbin
   • Protocols: HTTP, HTTPS
   • Path(s): /mock

5. Click Save.

The Konnect API uses Personal Access Token (PAT) authentication. You can obtain your PAT from the personal access token page. The PAT must be passed in the Authorization header of all requests.

1. Get the list of all control planes so you can copy the control plane ID associated with the default control plane:

     curl --request GET \
    --url https://us.api.konghq.com/v2/control-planes \
    --header 'Authorization: Bearer <personal-access-token>' \
    --header 'accept: application/json'
   

   In this guide, we will assign your service to the default control plane for the sake of simplicity.

2. Create a service for your API that is assigned to the default control plane:

     curl --request POST \
    --url https://{region}.api.konghq.com/v2/control-planes/{defaultControlPlaneId}/core-entities/services \
    --header 'Authorization: Bearer <personal-access-token>' \
    --header 'Content-Type: application/json' \
    --header 'accept: application/json' \
    --data '{
        "name": "my_service",
        "host": "httpbin.konghq.com",
        "path": "/mock"
    }'
   

   This service represents your backend API. Be sure to replace the PAT as well as the following placeholders with your own values:

   • defaultControlPlaneId: The ID of the default control plane. This associates the service with that control plane.
   • name: The name you want to display for your service.
   • host: The host of the upstream server. This is case sensitive.
   • path: The path to be used in requests to the upstream server. Be sure to save the service ID from the response to use it in the next step.
3. Add a route to your service:

     curl --request POST \
    --url https://{region}.api.konghq.com/v2/control-planes/{defaultControlPlaneId}/core-entities/routes \
    --header 'Authorization: Bearer <personal-access-token>' \
    --header 'Content-Type: application/json' \
    --header 'accept: application/json' \
    --data '{
        "name": "my_route",
        "hosts": [
          "httpbin.konghq.com"
        ],
        "paths": [
          "/mock"
        ],
        "service": {
          "id": "49248arf-b90c-4c0b-9529-3a949dfc10d1"
        }
    }'
   

   This route defines what is exposed to clients. Be sure to replace the PAT as well as the following placeholders with your own values:

   • defaultControlPlaneId: The ID of the default control plane. This associates the service with that control plane.
   • name: The name you want to display for your route.
   • host: A list of domain names that match this route. This is case sensitive.
   • path: A list of paths that match this route.
   • "service": "id": The ID of the service you created in the previous step. This should be part of the response from the previous request.