Skip to main content
Feedback

How to connect to Kong

Connect your Kong Gateway to Boomi's API Control Plane. You can also connect via the Kong Konnect Cloud API.

Prerequisites

To proceed, you will need the following:

  • Access to the instance of your Kong Gateway (Open Source)

    • The Kong Gateway needs a database, otherwise neither applications nor subscriptions can be created.

  • Docker to utilize the image of our agent, which acts as an intermediary.

Create a new Environment

To get started, open API Control Plane and follow the instructions below.

  1. Navigate to Environments in the menu on the left side.

  2. Select Register Gateway.

  3. Select Kong.

Choose Platform Type

  1. Set up the connection to Kong. Add the Gateway Name and URL.

    note

    For Kong Community, the URL is your Kong Management API URL. For Kong Konnect, the URL is the Admin URL. If necessary, refer to "Obtain your Kong Konnect Admin URL" below.

    • If you are not sure whether you have the correct URL, you can try to access <URL>/services or <URL>/consumers. Both should return a valid response and no errors.

  2. If necessary, enable Use Kong Konnect to connect your gateway through Kong's cloud platform. It provides a managed connection and centralized control.

    • If Kong Konnect is enabled, add an Authentication Token issued by Kong Konnect. The token must be valid for the selected Kong organization and have permission to manage the gateway configuration.

  3. Select Next.

  4. Add the following information to the Environment Wizard:

    • Technical Name - The technical name of an API must be unique.
    • Display Name - The display name can differ from the technical name and does not have to be unique.
    • URL - The base URL at which the APIs from this environment are made available. It is used to generate the full API URL that is displayed to users after subscribing to an API.

  5. Select Connect to Gateway.

  6. Select Download and Next. A Docker file downloads.

  7. Run the specified command in the same directory of the downloaded file and select Done.

Check the Agent's Status

  1. Select Environments in the menu on the left side.

  2. Your Agent is now connected to API Control Plane. Click on the tile or the entry in the table to get more detailed information about the status of the connection. This can be useful in case of an error.

Obtain your Kong Konnect Admin URL

  1. In Kong, select your API Gateway.
  2. Select Connect in the top right.
  3. Select Admin API.
  4. Copy the URL from the CURL command.
On this Page