Connect Kong

You connect Kong under Integrations → API Gateways. You give the connection a name, enter your Kong Admin API Url, and paste an admin Key. Then you run Test Connection. The core flow works on Kong today; some per-key operations do not yet.

Which Kong editions can you connect?

The Select an API Gateway Type list shows Kong Community Edition and Kong Enterprise Edition as separate rows. The Community Edition row opens the Kong connect form and runs through the Kong adapter. Both, where connected, share the same connect fields and the same adapter behavior.

The connect fields below are the same regardless of edition: a name, the Admin API Url, and an admin Key.

Where do you connect Kong?

Go to Integrations → API Gateways, choose + Add Gateway, and on Select an API Gateway Type pick Kong Community Edition, then connect.

1. Open Integrations → API Gateways.
2. Choose + Add Gateway.
3. On Select an API Gateway Type, select Kong Community Edition.
4. Confirm the selection to open the connect form. The gateway type is shown at the top.

What does each Kong field mean?

The connect form asks for a name, the Admin API URL, and an admin key. The Key is write-only, so Apiable does not show it again after you save.

A trailing slash on the Url is removed when you save, so https://kong-admin.example.com/ is stored as https://kong-admin.example.com.

How do you expose the Admin API to Apiable safely?

Route Kong's Admin API through Kong itself. Create a service that points at the Admin API on loopback 127.0.0.1:8001, add a route for it, and protect that route with the key-auth plugin. Apiable then reaches the Admin API over your normal proxy with a key.

This keeps port 8001 closed to the outside while still letting Apiable manage consumers, keys, and plugins through an authenticated route. Run these against your Admin API, then use the proxied route as the Url and the key-auth key as the Key in Apiable.

1. Create a service named admin-api that targets the Admin API on loopback:

curl -i -X POST http://localhost:8001/services \
  --data "name=admin-api" \
  --data "host=127.0.0.1" \
  --data "port=8001"

2. Add a route so the service is reachable on a path, for example /admin-api:

curl -i -X POST http://localhost:8001/services/admin-api/routes \
  --data "paths[]=/admin-api"

3. Protect the route with key-auth so it needs a key:

curl -i -X POST http://localhost:8001/services/admin-api/plugins \
  --data "name=key-auth"

4. In Apiable, set Url to the proxied Admin API, for example https://kong.example.com/admin-api, and set Key to a key-auth key you issue for this route.

How do you test and save the Kong connection?

Fill in all three fields, then click the refresh control labelled Test Connection. Apiable calls your Admin API URL with the key to confirm it works. A green check reads passed; a red mark reads failed. Then click Save Changes.

1. Enter Name, Url, and Key. Test Connection stays disabled until all three are filled.
2. Click the refresh control to run Test Connection. Apiable sends a request to your Admin API URL with the apikey header as the check.
3. Read the result: a green check means the test passed; a red mark means it failed.
4. Click Save Changes. The gateway appears on the API Gateways list with its Type, Created, and Edited times.

How do you point the Kong gateway at an Authorization Server?

Open the saved gateway and go to its Authorization tab. Choose the OAuth handler: Gateway-native only or Authorization Server. Picking Authorization Server reveals a picker of your connected servers.

Gateway-native Kong issues OAuth2 apps and JWT credentials through the Kong adapter. The tab also shows a Level 0 API Key section and a Product-level governance pairing mode, then Save Changes. See Authorization Servers.

Where do your Kong APIs appear after connecting?

They appear when you build a plan. Apiable lists your Kong services as APIs, and you choose which the plan exposes. The connect form itself only sets up the connection.

Apiable gates each plan with a Kong ACL group, so a consumer's key only reaches the services in plans they subscribe to. When a consumer subscribes, Apiable creates a Kong consumer, a key-auth key or OAuth2 app, ACL group membership, and the plan's rate-limiting. See APIs and coupling and Rate limits.

What does Apiable support on Kong today?

The core flow: connect the gateway, sync its services as APIs, and deploy subscriptions by creating Kong consumers, keys, ACL group membership, and rate-limiting. Several per-key operations are not yet implemented on Kong.

These operations are not yet implemented on Kong:

• Rotating a subscription's secret.
• Enabling or disabling an individual API key.
• Validating that a plan already exists on the gateway.
• Reading usage per plan or per key from the gateway.

Troubleshooting

Match what you see to the fix.

Where to next