API Service Graph Connector for Kong Gateway

  • Release version: Australia
  • Updated March 12, 2026
  • 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 enables customers to import detailed API information from Kong Gateway applications directly into the ServiceNow Configuration Management Database (CMDB). This integration supports consistent API data normalization, enhancing visibility, governance, and collaboration across your API estate without requiring direct Kong Gateway access.

    Show full answer Show less

    Key Features

    • Normalized Data Model: Imports API data into a standardized CMDB schema to maintain consistency with other technologies.
    • API Insights Workspace: Provides a centralized interface to analyze and interact with API data, improving governance and operational oversight.
    • Supported ServiceNow Versions: Compatible with Yokohama, Zurich, and Australia releases.

    Practical Use Cases

    • Maintain a comprehensive inventory of published and backend APIs, including usage and ownership details.
    • Trace API endpoints from customer-facing services to backend components, enabling impact analysis and incident creation for service disruptions.
    • Manage API-related vulnerabilities, security incidents, and compliance requirements effectively.

    Configuring the Connector

    Configuration is performed through the SGC Central view within the CMDB Workspace, which facilitates discovery, installation, lifecycle management, and troubleshooting of connections. You can also optionally include a Prometheus connection during setup to import Kong Gateway metrics via the Prometheus plugin.

    Data Mapping and Integration Process

    Data from Kong Gateway is ingested using the Robust Transform Engine (RTE) and inserted into the CMDB by the Identification and Reconciliation Engine (IRE). The integration supports scheduled data pulls from Kong Gateway applications. Key data sources map to specific staging and CMDB tables representing API components such as:

    • Kong Gateway
    • Kong Workspaces
    • Kong Load Balancers
    • Kong Targets
    • Kong Services (Managed API and API Backend)
    • Kong Routes (API Frontend)
    • Kong Consumers (API Consumer)
    • Kong Plugins (API Policy)

    This structured mapping ensures detailed and accurate representation of Kong Gateway API assets within the CMDB.

    Additional Tools

    Customers can use the IntegrationHub ETL application to view and manage data mappings, providing additional control and customization of how Kong Gateway data is transformed and stored.

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

    The API Insights workspace provides a centralized interface where you can analyze and interact with API data, without needing direct access to Kong Gateway, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.

    Supported ServiceNow versions

    • Yokohama
    • Zurich
    • Australia

    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.
    Note:
    You can also include a Prometheus connection and map it to the Kong Gateway connection during setup for importing Kong Gateway metrics data using the Prometheus plugin. To learn more about the Prometheus plugin, see Prometheus on the Kong Developer documentation site.

    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.