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

  • Release version: Xanadu
  • 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

    The API Service Graph Connector for Kong Gateway integration in ServiceNow enables periodic data collection from Kong Gateway applications. This data is stored across multiple specialized tables, primarily extending from Configuration Item (CI) [cmdbci] classes, as well as other non-CMDB tables. These tables capture detailed attributes and relationships, facilitating comprehensive visibility and management of Kong Gateway components within your CMDB.

    Show full answer Show less

    Key Tables and Their Purpose

    • Kong Gateway [cmdbcikonggateway]: Stores core gateway data such as ID, name, admin URL, database info, description, operational status, and version.
    • Kong Workspace [kongworkspace]: Captures workspace-specific data including ID, name, and associated API Gateway.
    • Kong Load Balancer [cmdbcikonglb]: Holds load balancer details like ID, name, algorithm, and operational status.
    • Kong Target [cmdbcikongtarget]: Contains target specifics such as ID, name, target endpoint, and operational status.
    • Managed API [cmdbcimanagedapi]: Tracks APIs with lifecycle information, ID, name, base URL, type, model ID, and operational status.
    • API Backend [cmdbciapibackend]: Stores backend API attributes including host, path, URL, port, protocol, and status.
    • API Frontend [cmdbciapifrontend]: Contains frontend API details like host, method, path, URL, protocol, and status.
    • API Consumer [apiconsumer]: Holds consumer data such as ID, custom ID, username, and linked API Gateway.
    • API Policy [apipolicy]: Details policy configurations including frontend, active status, protocols, linked managed API, consumer, and API Gateway.
    • Key Value [cmdbkeyvalue]: Used for storing key-value pairs related to configuration items.

    Key Relationships

    The integration defines important relationships between these tables to accurately model dependencies and associations:

    • Kong Gateway provides and references multiple components like Load Balancer, Managed API, Workspace, API Policy, and API Consumer.
    • Kong Workspace references the Kong Gateway.
    • Kong Load Balancer contains Kong Targets and references Key Value entries.
    • Kong Target references Key Value entries.
    • Managed API is used by API Frontend and API Backend classes.
    • API Backend is used by Kong Load Balancer and is linked to API Frontend.
    • API Frontend uses API Backend as an endpoint.
    • API Consumer references Kong Gateway.
    • API Policy references Kong Gateway.

    Practical Benefits for ServiceNow Customers

    By leveraging these tables and their relationships, customers gain a rich, structured representation of Kong Gateway environments within their ServiceNow CMDB. This enables improved configuration management, operational insight, and integration with ServiceNow IT workflows. Customers can expect:

    • Accurate tracking of Kong Gateway components and their configurations.
    • Clear visibility into the relationships between gateways, APIs, policies, consumers, and load balancers.
    • Support for lifecycle and status monitoring of APIs and infrastructure elements.
    • Enhanced ability to manage API services and enforce governance through policy and consumer data.

    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