How To Onboard An Application Using Kong API Gateway

Prerequisites

• The APIsec platform requires the Kong Gateway Server URL and an API Key to connect using Key authentication

  • Server URL: Get the address where Kong Admin API is accessible.
  • API Key: Obtain an API Key with read access to the following Admin API resources, which are used later
    • /services and /services/{service}/routes (for discovery and OAS generation flows)

• The APIsec platform requires the Kong Gateway Server URL and username, password to connect using Basic authentication

  • Server URL: Get the address where Kong Admin API is accessible.
  • Username + Password for the Admin API
  • Same read permissions as above (services and routes)

Start Adding a New Application

• Open your browser and visit: https://<your-tenant>.apisecapps.com

• Click on the "Add Application" button.

  

Select Kong Gateway

• Choose the "Kong Gateway" option.

• Register application from Kong Gateway, enable the toggle button

  

• If existing connections are available, they will be displayed in the Connections list. To create a new connection, click New Connection.

• If no connections exist, a connection form is displayed, allowing you to enter the required details and create a connection.

  

---

Enter Application Details

• Fill the Form Name, Server URL, and select Auth Type as a Basic Auth.

• Add Username and Password for Basic Auth

  

• Click Test Connection

  

• Test Connection Success Message

  

• Click "Create Connection"

  

• Select SERVICE NAME

  

• Click Continue

  

• Click Onboard

  

• Kong application Dashboard.

  

Edit Kong Connection

To Edit Postman connection

• Open your browser and visit: https://<your-tenant>.apisecapps.com

• Click Integrations tab

  

• Click Onboard Applications adjacent to the Kong

  

• A list of existing Kong connections is displayed.

  

• Select the Pencil icon next to the connection you want to edit.

  

• Update the required details and Click on Test Connection

  

• once Test connection successfull then Click on Update Connection

  

• The updated connection is now displayed in the connections list.

  

Delete Kong Connection

To Edit Postman connection

• Open your browser and visit: https://<your-tenant>.apisecapps.com

• Click Integrations tab

  

• Click Onboard Applications adjacent to the Kong

  

• A list of existing Kong connections is displayed.

  

• Select the Delete icon next to the connection you want to delete.

  

• Click Delete to confirm

  

• The deleted connection is no longer displayed in the connections list.

  

Onboarding Kong application through file upload

• Open your browser and visit: https://<your-tenant>.apisecapps.com

• Click on the Add Application.

  

• Choose the Kong Gateway.

  

• Enter Name of Application and Upload the decK file in JSON format.

  

• Click Continue

  

• Select OAS from the list

  

• Click Continue

  

• Click Onboard

  

• Kong application dashboard