API Service Graph Connector for Kong Gateway

  • Release version: Washingtondc
  • Updated March 21, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of API Service Graph Connector for Kong Gateway

    The ServiceNow® API Service Graph Connector for Kong Gateway allows users to import API details from a Kong Gateway application into the Configuration Management Database (CMDB). This integration supports ServiceNow versions Washington DC, Xanadu, and Yokohama.

    Show full answer Show less

    Key Features

    • Imports data into a normalized data model to ensure consistency across technologies.
    • Utilizes SGC Central in the CMDB Workspace for configuring connections and managing the lifecycle of the connector.
    • Employs the Robust Transform Engine (RTE) for mapping and transforming data into CMDB Configuration Item (CI) classes.
    • Data is inserted into the CMDB using the Identification and Reconciliation Engine (IRE).

    Use Cases

    • Maintain an inventory of exposed and backend APIs, identifying published APIs and their usage.
    • Track APIs from customer-facing endpoints to underlying services, creating incidents for reported issues.
    • Address vulnerabilities and security incidents related to API endpoints, while fulfilling compliance requirements.

    Data Mapping

    Data from Kong Gateway is mapped to CMDB CI classes through predefined staging tables. The integration can be configured to periodically pull data, ensuring the CMDB is up-to-date with API information.

    Next Steps

    To configure the connector, refer to the guide on configuring the API Service Graph Connector for Kong Gateway using SGC Central. For a detailed overview of data storage during the integration process, consult the documentation on target tables for storing API Service Graph Connector data.

    Use the ServiceNow® API Service Graph Connector for Kong Gateway to import API details from a Kong Gateway application into the Configuration Management Database (CMDB).

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Key features

    Import data into a normalized data model for consistency across other technologies.

    Supported ServiceNow versions

    • Washington DC
    • Xanadu
    • Yokohama

    Use cases

    You can use the API Service Graph Connector for Kong Gateway to:
    • Maintain an end-to-end inventory of exposed and backend APIs, identifying what APIs are published, used, and by whom.
    • Track APIs from customer-facing endpoints to the underlying services, identifying impacted endpoints when services change or fail and creating incidents for reported issues.
    • Address vulnerabilities and security incidents related to API endpoints, and create compliance requirements.

    Configuring a connection for the connector

    You can configure a connection for the connector by using the SGC Central view in the CMDB Workspace. The SGC Central view enables you to discover and install connectors, and then effectively manage the full life cycle of creating, editing, monitoring, and debugging connections. To configure the connector using SGC Central, see Configure API Service Graph Connector for Kong Gateway using SGC Central.

    Important:
    Unless there are configuration issues, use the SGC Central view in the CMDB Workspace to configure the connection for the connector, as the guided setup method is being deprecated.

    Data mapping

    Data from the Kong Gateway data sources is mapped and transformed into the CMDB Configuration Item (CI) class definitions using the Robust Transform Engine (RTE). Data is inserted into the CMDB using the Identification and Reconciliation Engine (IRE).

    When you complete setting up the connection, you can configure the integration to periodically pull data from a Kong Gateway application.

    The following table lists the data sources in the order they run, the staging tables, and the target tables as CMDB CI and non-CMDB classes for a Kong Gateway application.
    Table 1. Data mapping for Kong Gateway
    Data source Staging table Target tables
    SG-Kong Gateway SG-Kong Gateway [sn_kong_integ_sg_kong_gateway]

    Kong Gateway
    SG-Kong Workspaces SG-Kong Workspaces [sn_kong_integ_sg_kong_workspaces] Kong Workspace
    SG-Kong Load Balancers SG-Kong Load Balancers [sn_kong_integ_sg_kong_lbs] Kong Load Balancer
    SG-Kong Targets SG-Kong Targets [sn_kong_integ_sg_kong_targets] Kong Target

    Key Value
    SG-Kong Services SG-Kong Services [sn_kong_integ_sg_kong_services] Managed API

    API Backend

    Key Value
    SG-Kong Routes SG-Kong Routes [sn_kong_integ_sg_kong_routes] API Frontend
    SG-Kong Consumers SG-Kong Consumers [sn_kong_integ_sg_kong_consumers] API Consumer
    SG-Kong Plugins SG-Kong Plugins [sn_kong_integ_sg_kong_plugins] API Policy

    For more information on where data is saved when pulling data from a Kong Gateway application, see Target tables for storing API Service Graph Connector for Kong Gateway data.

    You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.