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

  • Release version: Yokohama
  • 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 documentation describes the key tables within ServiceNow that store data collected through the API Service Graph Connector for Kong Gateway integration. After configuring the connection, data from Kong Gateway applications is periodically imported and saved into specific tables extending the Configuration Item [cmdbci] class and other related tables. Understanding these tables and their populated attributes enables customers to effectively manage and utilize Kong Gateway-related data within their CMDB and ServiceNow environment.

    Show full answer Show less

    Key Tables and Their Attributes

    • Kong Gateway [cmdbcikonggateway]: Captures core gateway details such as ID, name, admin URL, database type, description, operational status, and version.
    • Kong Workspace [kongworkspace]: Stores workspace information including ID, name, and associated API Gateway.
    • Kong Load Balancer [cmdbcikonglb]: Contains load balancer details like ID, name, algorithm used, and operational status.
    • Kong Target [cmdbcikongtarget]: Holds target-specific data including ID, name, target address, and operational status.
    • Managed API [cmdbcimanagedapi]: Records managed API attributes such as life cycle stage and status, ID, name, base URL, type, model ID, and operational status.
    • API Backend [cmdbciapibackend]: Includes backend API information like host, ID, path, URL, name, port, protocol, and operational status.
    • API Frontend [cmdbciapifrontend]: Details frontend API data such as host, ID, method, path, URL, name, protocol, and operational status.
    • API Consumer [apiconsumer]: Stores consumer details including ID, API Gateway association, custom ID, and username.
    • API Policy [apipolicy]: Captures policy data including frontend, ID, active status, name, protocols, managed API, consumer, and API Gateway references.
    • Key Value [cmdbkeyvalue]: Contains configuration key-value pairs linked to various configuration items.

    Key Relationships Between Tables

    • Kong Gateway provides and is related to Kong Load Balancer, Managed API, Kong Workspace, API Policy, and API Consumer.
    • Kong Workspace references Kong Gateway.
    • Kong Load Balancer contains Kong Target entries and references key-value pairs.
    • Kong Target references key-value pairs.
    • Managed API is used by API Frontend and API Backend.
    • API Backend uses Kong Load Balancer.
    • API Frontend uses endpoints from API Backend.
    • API Consumer references Kong Gateway.
    • API Policy references Kong Gateway and key-value pairs.

    Practical Implications for ServiceNow Customers

    By understanding these tables and their attributes, ServiceNow customers can:

    • Effectively monitor and manage Kong Gateway configurations and operational status within their CMDB.
    • Track relationships between gateways, load balancers, APIs, consumers, and policies for comprehensive service mapping and impact analysis.
    • Leverage detailed configuration data to enhance governance, compliance, and operational insights related to API management.
    • Utilize key-value configuration data for custom settings and integration specifics.

    This structure supports a robust, integrated view of Kong Gateway API infrastructure within ServiceNow, enabling better service management and operational efficiency.

    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