Target tables for storing API Service Graph Connector for Kong Gateway data

  • Release version: Zurich
  • Updated October 16, 2025
  • 3 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 Target tables for storing API Service Graph Connector for Kong Gateway data

    This document outlines how ServiceNow's API Service Graph Connector for Kong Gateway stores and organizes data collected from Kong Gateway applications. After setup, the integration periodically pulls data, which is saved into specific tables extending from theConfiguration item [cmdbci]classes and other related non-CMDB tables. This structured data model helps ServiceNow customers maintain a comprehensive and connected view of their Kong Gateway ecosystem within the CMDB.

    Show full answer Show less

    Key Tables and Their Roles

    • Kong Gateway [cmdbcikonggateway]: Captures core gateway attributes such as admin URL, version, database type, description, and operational status. It is central to relationships with load balancers, managed APIs, workspaces, API policies, and API consumers.
    • Kong Workspace [kongworkspace]: Holds workspace-specific data including API gateway association, linking back to the Kong Gateway.
    • Kong Load Balancer [cmdbcikonglb]: Stores load balancer details like algorithm and operational status. It relates to Kong Targets and key-value configurations.
    • Kong Target [cmdbcikongtarget]: Contains target endpoint information such as target address and operational status, and is associated with key-value entries.
    • Managed API [cmdbcimanagedapi]: Records API lifecycle stages, base URLs, types, operational status, and relationships to API frontends and backends.
    • API Backend [cmdbciapibackend] and API Frontend [cmdbciapifrontend]: Store backend and frontend API details respectively, including hosts, paths, protocols, and operational status. These classes connect to load balancers and each other to model API traffic flow.
    • API Consumer [apiconsumer]: Captures consumer information tied to the API Gateway and Kong Gateway, including usernames and custom IDs.
    • API Policy [apipolicy]: Maintains policy configurations such as active status, protocols, and references to managed APIs, consumers, and gateways.
    • Key Value [cmdbkeyvalue]: Holds key-value pairs linked to configuration items, supporting extensible metadata storage.

    Data Relationships

    The tables are interconnected through relationships that define the architecture of the Kong Gateway environment within ServiceNow’s CMDB, facilitating comprehensive service graph modeling:

    • Kong Gateway provides and references load balancers, managed APIs, workspaces, policies, and consumers.
    • Kong Load Balancer contains targets and references key-value pairs.
    • Managed APIs use API frontends and backends, establishing API flow paths.
    • API Frontends use API backends as endpoints, creating request routes.
    • API Consumers and API Policies reference the Kong Gateway to maintain consumer and policy context.

    Practical Benefits for ServiceNow Customers

    By leveraging these tables and their relationships, customers can:

    • Gain an accurate, up-to-date CMDB representation of their Kong Gateway components and configurations.
    • Understand dependencies and interactions among gateways, APIs, load balancers, and consumers.
    • Support impact analysis, operational status tracking, and lifecycle management for API services.
    • Enhance governance and compliance through detailed policy and consumer data linked directly to configuration items.

    When you complete setting up the connection, you can configure the integration to periodically pull data from a Kong Gateway application. The data is saved in tables that extend from the Configuration item [cmdb_ci] classes and other non-CMDB tables.

    Kong Gateway [cmdb_ci_kong_gateway]

    The following attributes in the Kong Gateway [cmdb_ci_kong_gateway] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Admin URL admin_url
    Database database
    Description short_description
    Operational status operational_status
    Version version
    Table 1. Relationships created for Kong Gateway
    Parent class Relationship type Child class
    Kong Gateway [cmdb_ci_kong_gateway] Provides::Provided by Kong Load Balancer [cmdb_ci_kong_lb]
    Kong Gateway [cmdb_ci_kong_gateway] Provides::Provided by Managed API [cmdb_ci_managed_api]
    Kong Gateway [cmdb_ci_kong_gateway] Reference Kong Workspace [kong_workspace]
    Kong Gateway [cmdb_ci_kong_gateway] Reference API Policy [api_policy]
    Kong Gateway [cmdb_ci_kong_gateway] Reference API Consumer [api_consumer]

    Kong Workspace [kong_workspace]

    The following attributes in the Kong Workspace [kong_workspace] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    API Gateway api_gateway
    Table 2. Relationship created for Kong Workspace
    Parent class Relationship type Child class
    Kong Workspace [kong_workspace] Reference Kong Gateway [cmdb_ci_kong_gateway]

    Kong Load Balancer [cmdb_ci_kong_lb]

    The following attributes in the Kong Load Balancer [cmdb_ci_kong_lb] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Algorithm algorithm
    Operational status operational_status
    Table 3. Relationships created for Kong Load Balancer
    Parent class Relationship type Child class
    Kong Load Balancer [cmdb_ci_kong_lb] Contains::Contained by Kong Target [cmdb_ci_kong_target]
    Kong Load Balancer [cmdb_ci_kong_lb] Reference Key Value [cmdb_key_value]

    Kong Target [cmdb_ci_kong_target]

    The following attributes in the Kong Target [cmdb_ci_kong_target] table are populated by collected data:
    Attribute label Attribute name
    ID id
    Name name
    Target target
    Operational status operational_status
    Table 4. Relationship created for Kong Target
    Parent class Relationship type Child class
    Kong Target [cmdb_ci_kong_target] Reference Key Value [cmdb_key_value]

    Managed API [cmdb_ci_managed_api]

    The following attributes in the Managed API [cmdb_ci_managed_api] table are populated by collected data:
    Attribute label Attribute name
    Life Cycle Stage life_cycle_stage
    Life Cycle Stage Status life_cycle_stage_status
    ID id
    Name name
    Base URL base_url
    Type type
    Model ID model_id
    Operational status operational_status
    Table 5. Relationships created for Managed API
    Parent class Relationship type Child class
    Managed API [cmdb_ci_managed_api] Uses::Used by API Frontend [cmdb_ci_api_frontend]
    Managed API [cmdb_ci_managed_api] Uses::Used by API Backend [cmdb_ci_api_backend]

    API Backend [cmdb_ci_api_backend]

    The following attributes in the API Backend [cmdb_ci_api_backend] table are populated by collected data:
    Attribute label Attribute name
    Host host
    ID id
    Path path
    URL url
    Name name
    Port port
    Protocol protocol
    Operational status operational_status
    Table 6. Relationship created for API Backend
    Parent class Relationship type Child class
    API Backend [cmdb_ci_api_backend] Uses::Used by Kong Load Balancer [cmdb_ci_kong_lb]

    API Frontend [cmdb_ci_api_frontend]

    The following attributes in the API Frontend [cmdb_ci_api_frontend] table are populated by collected data:
    Attribute label Attribute name
    Host host
    ID id
    Method method
    Path path
    URL url
    Name name
    Protocol protocol
    Operational status operational_status
    Table 7. Relationship created for API Frontend
    Parent class Relationship type Child class
    API Frontend [cmdb_ci_api_frontend] Use End Point To::Use End Point From API Backend [cmdb_ci_api_backend]

    API Consumer [api_consumer]

    The following attributes in the API Consumer [api_consumer] table are populated by collected data:
    Attribute label Attribute name
    ID id
    API Gateway api_gateway
    Custom ID custom_id
    Username username
    Table 8. Relationship created for API Consumer
    Parent class Relationship type Child class
    API Consumer [api_consumer] Reference Kong Gateway [cmdb_ci_kong_gateway]

    API Policy [api_policy]

    The following attributes in the API Policy [api_policy] table are populated by collected data:
    Attribute label Attribute name
    Frontend frontend
    ID id
    Active active
    Name name
    Protocols protocols
    Managed API managed_api
    Consumer consumer
    API Gateway api_gateway
    Table 9. Relationship created for API Policy
    Parent class Relationship type Child class
    API Policy [api_policy] Reference Kong Gateway [cmdb_ci_kong_gateway]

    Key Value [cmdb_key_value]

    The following attributes in the Key Value [cmdb_key_value] table are populated by collected data:
    Attribute label Attribute name
    Configuration item configuration_item
    Key key
    Value value