Configure API Service Graph Connector for Kong Gateway using SGC Central

  • Release version: Washingtondc
  • Updated April 3, 2025
  • 3 minutes to read

    • Set up scheduled import jobs to pull in Kong Gateway data into your Configuration Management Database (CMDB).

    Before you begin

    Install API Service Graph Connector for Kong Gateway version 2.0.0 or later from the ServiceNow Store. For ServiceNow Store installation steps, see Install a ServiceNow Store application.

    Role required: The following table shows the roles required for each stage of the playbook.

    Table 1. Role required for each playbook stage
    Stage Role
    Prerequisites admin
    Setup cmdb_inst_admin or admin

    About this task

    The playbook experience for onboarding connectors is activated with SGC Central in the CMDB Workspace. To configure the SGC Central application, see Configuring SGC Central and for more information on how to interact with a playbook, see Interact with Playbook.

    Procedure

    1. Navigate to Workspaces > CMDB Workspace.
    2. In the CMDB Workspace, select SGC Central.
    3. On the Overview page, select Create connection.
      Tip:
      Alternatively, you can select Create connection on the All connections page.
    4. On the Create connection window, select the Kong connector type, and then select Create connection.
    5. Complete the initial prerequisites when setting up a connection for the first time using a connector.
      Note:
      This step is required only during the first-time setup. See Perform initial setup tasks when creating a connection in SGC Central.
    6. Select a template for the authentication type to create a connection.
      1. In the Setup stage of the playbook, select the Select alias template activity.
      2. Select a template type.
        • Kong RBAC Authentication: Select when using token-based authentication.
        • Kong Basic Authentication: Select when using basic authentication.
    7. Enter connection details and test the API connection for importing Kong Gateway data.
      1. In the Setup stage of the playbook, select the Configure and test connection activity.
      2. On the form, fill in the fields.
        Table 2. Configure and test connection form
        Field Description
        Connection Name Name to identify the Kong Gateway connection record.
        Host Name Admin URL address of the Kong Admin API server.
        Protocol Protocol used for the connection ensuring secured communication between the client and the Kong server.
        Override default port Port used by the Kong Admin API.
        API Key Authentication secret to connect to the Kong Gateway service. This field appears only when Kong RBAC Authentication is selected in the Select alias template activity.
        User Name User name required for authenticating requests to the Kong Gateway Admin API. This field appears only when Kong Basic Authentication is selected in the Select alias template activity.
        Password Password associated with the user name required for authenticating requests. This field appears only when Kong Basic Authentication is selected in the Select alias template activity.
      3. Select Create and test connection.
      4. Once the connection test is complete, select Continue.
    8. Optional: Set the configuration properties for the connection.
      1. In the Setup stage of the playbook, select the Set configuration properties activity.
      2. In the Exclude workspaces field, enter the workspace that must be excluded from import.

        For multiple workspaces, separate them with commas. For example: workspace1,workspace2. If you leave this field empty, the data sources within the connector import data from all the workspaces.

      3. Select the Import tags check box, to ingest tags from the Kong Gateway service.
        When selected, specify the key-value pair separator for tags in the Tags value separator field. If not selected, tags won't be fetched.
      4. In the Tags value separator field, enter the separator for key and value in tags.
        For example, if the tag value separator is set to =, the tag env=prod is saved with env as the key and prod as the value.

        If left empty, no tags will be ingested.

      5. Select Continue.
    9. Configure the import schedule to import data at regular intervals.
      1. In the Setup stage of the playbook, select the Configure import schedule activity.
      2. Select Configure import schedule.
      3. Expand the Parent scheduled data import within the Import schedules list to select the SG-Kong Gateway import schedule.
      4. In the Configure import schedule dialog box, select the Active check box, and then fill in the run schedule and time details.

        For more information, see Schedule a data import.

      5. Select Save.
        Alternatively, select Execute Now to execute the import schedule immediately.
      6. Select Continue.
    10. In the Setup stage of the playbook, select the Confirm connection setup activity to check whether the connection was configured.

    What to do next

    Select View all connections to review the connection details. The configured connection appears in the Installed connections list.