Skip to main content

Onboard an API with 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​

Select Kong Gateway​

  • Choose the Kong Gateway option. Choose the Kong Gateway

  • To register an application from Kong Gateway, enable the toggle button

    Kong Gateway toggle

  • 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.

    New Connection option


Enter application details​

  • Fill in the form with Name and Server URL, and select Auth Type as Basic Auth.

  • Add Username and Password for Basic Auth

    Kong connection form with Basic Auth credentials

  • Click Test Connection

    Test Connection button

  • Test Connection Success Message

    Connection test success message

  • Click Create Connection

    Create Connection button

  • Select SERVICE NAME

    Select the service name

  • Click Continue

    Continue button

  • Click Onboard

    Onboard button

  • Kong application Dashboard.

    Kong application dashboard

Edit Kong connection​

To edit the Kong connection

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

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Kong

    Onboard Applications for Kong

  • A list of existing Kong connections is displayed.

    Kong connections list

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

    Pencil icon next to a connection

  • Update the required details and click Test Connection

    Test Connection button

  • Once the connection test succeeds, click Update Connection

    Update Connection button

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

    Updated connections list

Delete Kong connection​

To delete the Kong connection

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

  • Click Integrations tab

    Integrations tab

  • Click Onboard Applications adjacent to the Kong

    Onboard Applications for Kong

  • A list of existing Kong connections is displayed.

    Kong connections list

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

    Delete icon next to a connection

  • Click Delete to confirm

    Delete confirmation dialog

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

    Connections list after deletion

Onboard a Kong application through file upload​

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

  • Click on the Add Application.

    Add Application

  • Choose the Kong Gateway.

    Choose the Kong Gateway

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

    Application name and decK file upload

  • Click Continue

    Continue button

  • Select OAS from the list

    Select the OAS from the list

  • Click Continue

    Continue button

  • Click Onboard

    Onboard button

  • Kong application dashboard

    Kong application dashboard